From 545a61980c4c80267ec06bd9a11b01c27eaf59e3 Mon Sep 17 00:00:00 2001 From: Vikas Katariya Date: Wed, 3 Jul 2024 09:36:43 +0100 Subject: [PATCH 1/3] docs: Fix syntax for docs rendering The rendering of url does not happen due to missing syntax for Corstone-1000 software stack. Signed-off-by: Vikas Katariya --- documentation/developer_manual/corstone1000.rst | 2 +- documentation/developer_manual/corstone1000fvp.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/developer_manual/corstone1000.rst b/documentation/developer_manual/corstone1000.rst index d584610..00e993a 100644 --- a/documentation/developer_manual/corstone1000.rst +++ b/documentation/developer_manual/corstone1000.rst @@ -19,4 +19,4 @@ Corstone-1000 for MPS3 |Arm Corstone-1000 Technical Overview|_. For more information about the software stack for the Corstone-1000, see - |Arm Corstone-1000 Software| + |Arm Corstone-1000 Software|_. diff --git a/documentation/developer_manual/corstone1000fvp.rst b/documentation/developer_manual/corstone1000fvp.rst index 10ab71b..0d26863 100644 --- a/documentation/developer_manual/corstone1000fvp.rst +++ b/documentation/developer_manual/corstone1000fvp.rst @@ -19,7 +19,7 @@ Corstone-1000 FVP |Arm Corstone-1000 Technical Overview|_. For more information about the software stack for the Corstone-1000, see - |Arm Corstone-1000 Software| + |Arm Corstone-1000 Software|_. To read documentation about the Corstone-1000 FVP, see the |Fast Models Fixed Virtual Platforms (FVP) Reference Guide|_. -- GitLab From aab3f0db90276aa3c362a29a43095fe2bed5c737 Mon Sep 17 00:00:00 2001 From: Vikas Katariya Date: Wed, 3 Jul 2024 09:39:35 +0100 Subject: [PATCH 2/3] docs: Remove unwanted statement Since Corstone-1000 points all the required documentation, We do not need to point to a N1SDP documentation link. Signed-off-by: Vikas Katariya --- documentation/developer_manual/corstone1000.rst | 3 --- documentation/developer_manual/corstone1000fvp.rst | 3 --- 2 files changed, 6 deletions(-) diff --git a/documentation/developer_manual/corstone1000.rst b/documentation/developer_manual/corstone1000.rst index 00e993a..2e0884a 100644 --- a/documentation/developer_manual/corstone1000.rst +++ b/documentation/developer_manual/corstone1000.rst @@ -12,9 +12,6 @@ Corstone-1000 for MPS3 * **Corresponding value for** ``MACHINE`` **variable**: ``corstone1000-mps3`` * **Target Platform Config**: ``kas/corstone1000-mps3.yml`` - This supported target platform is the Corstone-1000 for MPS3, implemented in - |meta-arm-bsp|_. - To read documentation about the Corstone-1000, see the |Arm Corstone-1000 Technical Overview|_. diff --git a/documentation/developer_manual/corstone1000fvp.rst b/documentation/developer_manual/corstone1000fvp.rst index 0d26863..9fd4d58 100644 --- a/documentation/developer_manual/corstone1000fvp.rst +++ b/documentation/developer_manual/corstone1000fvp.rst @@ -12,9 +12,6 @@ Corstone-1000 FVP * **Corresponding value for** ``MACHINE`` **variable**: ``corstone1000-fvp`` * **Target Platform Config**: ``kas/corstone1000-fvp.yml`` - This supported target platforms is the Corstone-1000 FVP, implemented in - |meta-arm-bsp|_. - To read documentation about the Corstone-1000, see the |Arm Corstone-1000 Technical Overview|_. -- GitLab From 59ca33eacf5a33c29c60aaaadf5dc057c7a5f5eb Mon Sep 17 00:00:00 2001 From: Vikas Katariya Date: Wed, 3 Jul 2024 09:46:35 +0100 Subject: [PATCH 3/3] docs: Fix the Corstone-1000 software stack link The Corstone-1000 software link needs to point to a release version instead of `latest`, as it relevant to particular release. Signed-off-by: Vikas Katariya --- documentation/variables.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/variables.py b/documentation/variables.py index c5154ac..c7c5944 100644 --- a/documentation/variables.py +++ b/documentation/variables.py @@ -32,7 +32,7 @@ variables which are referenced from documentation sources in this repository """ YOCTO_RELEASE = "scarthgap" - +DOCS_RELEASE = "scarthgap" general_links = { "link:meta-arm-bsp": @@ -47,7 +47,8 @@ general_links = { "link:Arm Corstone-1000 Technical Overview": "https://developer.arm.com/documentation/102360/0000", "link:Arm Corstone-1000 Software": - "https://corstone1000.docs.arm.com/en/latest/", + "https://corstone1000.docs.arm.com/en/" + f"{DOCS_RELEASE}", "link:Fast Models Fixed Virtual Platforms (FVP) Reference Guide": "https://developer.arm.com/documentation/100966/1119", "link:Fast Models Reference Guide": -- GitLab