summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2021-04-07 18:07:24 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-04-09 15:24:46 +0100
commitc380ba5a177de32e97820279685c4af6f837c010 (patch)
treec494289cda99f5bb76bad0d9492a3d1104d176d4 /documentation/sdk-manual
parent802ac0b75e42657c7ff9f4ff5b2816c65ad29eea (diff)
downloadpoky-c380ba5a177de32e97820279685c4af6f837c010.tar.gz
docs: replace anchor links
Anchor links are treated by Sphinx as external links and are not checked during build, meaning it is impossible to know if a link becomes broken or not. As a matter of fact, most of the anchor links replaced in this commit were actually broken. The README now states that anchor links are forbidden so that there's no need to go through such a change later on. (From yocto-docs rev: de9e4d26b46afa3c79137d07529a74553400d2e0) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual')
-rw-r--r--documentation/sdk-manual/appendix-customizing.rst25
-rw-r--r--documentation/sdk-manual/appendix-obtain.rst16
-rw-r--r--documentation/sdk-manual/extensible.rst11
-rw-r--r--documentation/sdk-manual/intro.rst4
-rw-r--r--documentation/sdk-manual/using.rst22
5 files changed, 38 insertions, 40 deletions
diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst
index cdfde8b4b2..8e7115046b 100644
--- a/documentation/sdk-manual/appendix-customizing.rst
+++ b/documentation/sdk-manual/appendix-customizing.rst
@@ -101,17 +101,15 @@ adjustments:
101 101
102- Generally, you want to have a shared state mirror set up so users of 102- Generally, you want to have a shared state mirror set up so users of
103 the SDK can add additional items to the SDK after installation 103 the SDK can add additional items to the SDK after installation
104 without needing to build the items from source. See the "`Providing 104 without needing to build the items from source. See the
105 Additional Installable Extensible SDK 105 ":ref:`sdk-manual/appendix-customizing:providing additional installable extensible sdk content`"
106 Content <#sdk-providing-additional-installable-extensible-sdk-content>`__"
107 section for information. 106 section for information.
108 107
109- If you want users of the SDK to be able to easily update the SDK, you 108- If you want users of the SDK to be able to easily update the SDK, you
110 need to set the 109 need to set the
111 :term:`SDK_UPDATE_URL` 110 :term:`SDK_UPDATE_URL`
112 variable. For more information, see the "`Providing Updates to the 111 variable. For more information, see the
113 Extensible SDK After 112 ":ref:`sdk-manual/appendix-customizing:providing updates to the extensible sdk after installation`"
114 Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__"
115 section. 113 section.
116 114
117- If you have adjusted the list of files and directories that appear in 115- If you have adjusted the list of files and directories that appear in
@@ -140,8 +138,8 @@ Changing the Extensible SDK Installer Title
140You can change the displayed title for the SDK installer by setting the 138You can change the displayed title for the SDK installer by setting the
141:term:`SDK_TITLE` variable and then 139:term:`SDK_TITLE` variable and then
142rebuilding the SDK installer. For information on how to build an SDK 140rebuilding the SDK installer. For information on how to build an SDK
143installer, see the "`Building an SDK 141installer, see the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`"
144Installer <#sdk-building-an-sdk-installer>`__" section. 142section.
145 143
146By default, this title is derived from 144By default, this title is derived from
147:term:`DISTRO_NAME` when it is 145:term:`DISTRO_NAME` when it is
@@ -189,9 +187,8 @@ the installed SDKs to update the installed SDKs by using the
189 variable to point to the corresponding HTTP or HTTPS URL. Setting 187 variable to point to the corresponding HTTP or HTTPS URL. Setting
190 this variable causes any SDK built to default to that URL and thus, 188 this variable causes any SDK built to default to that URL and thus,
191 the user does not have to pass the URL to the ``devtool sdk-update`` 189 the user does not have to pass the URL to the ``devtool sdk-update``
192 command as described in the "`Applying Updates to an Installed 190 command as described in the
193 Extensible 191 ":ref:`sdk-manual/extensible:applying updates to an installed extensible sdk`"
194 SDK <#sdk-applying-updates-to-an-installed-extensible-sdk>`__"
195 section. 192 section.
196 193
1973. Build the extensible SDK normally (i.e., use the 1943. Build the extensible SDK normally (i.e., use the
@@ -208,9 +205,9 @@ the installed SDKs to update the installed SDKs by using the
208 205
209Completing the above steps allows users of the existing installed SDKs 206Completing the above steps allows users of the existing installed SDKs
210to simply run ``devtool sdk-update`` to retrieve and apply the latest 207to simply run ``devtool sdk-update`` to retrieve and apply the latest
211updates. See the "`Applying Updates to an Installed Extensible 208updates. See the
212SDK <#sdk-applying-updates-to-an-installed-extensible-sdk>`__" section 209":ref:`sdk-manual/extensible:applying updates to an installed extensible sdk`"
213for further information. 210section for further information.
214 211
215Changing the Default SDK Installation Directory 212Changing the Default SDK Installation Directory
216=============================================== 213===============================================
diff --git a/documentation/sdk-manual/appendix-obtain.rst b/documentation/sdk-manual/appendix-obtain.rst
index 0fd421f31f..3c1dc52d19 100644
--- a/documentation/sdk-manual/appendix-obtain.rst
+++ b/documentation/sdk-manual/appendix-obtain.rst
@@ -68,10 +68,10 @@ Follow these steps to locate and hand-install the toolchain:
68 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh 68 $ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
69 69
70 During execution of the script, you choose the root location for the 70 During execution of the script, you choose the root location for the
71 toolchain. See the "`Installed Standard SDK Directory 71 toolchain. See the
72 Structure <#sdk-installed-standard-sdk-directory-structure>`__" 72 ":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
73 section and the "`Installed Extensible SDK Directory 73 section and the
74 Structure <#sdk-installed-extensible-sdk-directory-structure>`__" 74 ":ref:`sdk-manual/appendix-obtain:installed extensible sdk directory structure`"
75 section for more information. 75 section for more information.
76 76
77Building an SDK Installer 77Building an SDK Installer
@@ -177,10 +177,10 @@ build the SDK installer. Follow these steps:
177 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh 177 $ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
178 178
179 During execution of the script, you choose the root location for the 179 During execution of the script, you choose the root location for the
180 toolchain. See the "`Installed Standard SDK Directory 180 toolchain. See the
181 Structure <#sdk-installed-standard-sdk-directory-structure>`__" 181 ":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
182 section and the "`Installed Extensible SDK Directory 182 section and the
183 Structure <#sdk-installed-extensible-sdk-directory-structure>`__" 183 ":ref:`sdk-manual/appendix-obtain:installed extensible sdk directory structure`"
184 section for more information. 184 section for more information.
185 185
186Extracting the Root Filesystem 186Extracting the Root Filesystem
diff --git a/documentation/sdk-manual/extensible.rst b/documentation/sdk-manual/extensible.rst
index f1a114368a..baa432ef3b 100644
--- a/documentation/sdk-manual/extensible.rst
+++ b/documentation/sdk-manual/extensible.rst
@@ -21,8 +21,9 @@ hardware, and ease integration into the rest of the
21 21
22In addition to the functionality available through ``devtool``, you can 22In addition to the functionality available through ``devtool``, you can
23alternatively make use of the toolchain directly, for example from 23alternatively make use of the toolchain directly, for example from
24Makefile and Autotools. See the "`Using the SDK Toolchain 24Makefile and Autotools. See the
25Directly <#sdk-working-projects>`__" chapter for more information. 25":ref:`sdk-manual/working-projects:using the sdk toolchain directly`" chapter
26for more information.
26 27
27Why use the Extensible SDK and What is in It? 28Why use the Extensible SDK and What is in It?
28============================================= 29=============================================
@@ -1087,12 +1088,12 @@ links created within the source tree:
1087 1088
1088 - ``sysroot-destdir/``: Contains a subset of files installed within 1089 - ``sysroot-destdir/``: Contains a subset of files installed within
1089 ``do_install`` that have been put into the shared sysroot. For 1090 ``do_install`` that have been put into the shared sysroot. For
1090 more information, see the "`Sharing Files Between 1091 more information, see the
1091 Recipes <#sdk-sharing-files-between-recipes>`__" section. 1092 ":ref:`dev-manual/common-tasks:sharing files between recipes`" section.
1092 1093
1093 - ``packages-split/``: Contains subdirectories for each package 1094 - ``packages-split/``: Contains subdirectories for each package
1094 produced by the recipe. For more information, see the 1095 produced by the recipe. For more information, see the
1095 "`Packaging <#sdk-packaging>`__" section. 1096 ":ref:`sdk-manual/extensible:packaging`" section.
1096 1097
1097You can use these links to get more information on what is happening at 1098You can use these links to get more information on what is happening at
1098each build step. 1099each build step.
diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst
index e4b9b05ba6..d966efea77 100644
--- a/documentation/sdk-manual/intro.rst
+++ b/documentation/sdk-manual/intro.rst
@@ -176,8 +176,8 @@ image.
176You just need to follow these general steps: 176You just need to follow these general steps:
177 177
1781. *Install the SDK for your target hardware:* For information on how to 1781. *Install the SDK for your target hardware:* For information on how to
179 install the SDK, see the "`Installing the 179 install the SDK, see the ":ref:`sdk-manual/using:installing the sdk`"
180 SDK <#sdk-installing-the-sdk>`__" section. 180 section.
181 181
1822. *Download or Build the Target Image:* The Yocto Project supports 1822. *Download or Build the Target Image:* The Yocto Project supports
183 several target architectures and has many pre-built kernel images and 183 several target architectures and has many pre-built kernel images and
diff --git a/documentation/sdk-manual/using.rst b/documentation/sdk-manual/using.rst
index 29fb50465f..62967f5572 100644
--- a/documentation/sdk-manual/using.rst
+++ b/documentation/sdk-manual/using.rst
@@ -16,8 +16,9 @@ standard SDK.
16 " section. 16 " section.
17 17
18You can use a standard SDK to work on Makefile and Autotools-based 18You can use a standard SDK to work on Makefile and Autotools-based
19projects. See the "`Using the SDK Toolchain 19projects. See the
20Directly <#sdk-working-projects>`__" chapter for more information. 20":ref:`sdk-manual/working-projects:using the sdk toolchain directly`" chapter
21for more information.
21 22
22Why use the Standard SDK and What is in It? 23Why use the Standard SDK and What is in It?
23=========================================== 24===========================================
@@ -31,9 +32,9 @@ the extensible SDK, which provides an internal build system and the
31The installed Standard SDK consists of several files and directories. 32The installed Standard SDK consists of several files and directories.
32Basically, it contains an SDK environment setup script, some 33Basically, it contains an SDK environment setup script, some
33configuration files, and host and target root filesystems to support 34configuration files, and host and target root filesystems to support
34usage. You can see the directory structure in the "`Installed Standard 35usage. You can see the directory structure in the
35SDK Directory 36":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
36Structure <#sdk-installed-standard-sdk-directory-structure>`__" section. 37section.
37 38
38Installing the SDK 39Installing the SDK
39================== 40==================
@@ -120,9 +121,9 @@ architecture. The example assumes the SDK installer is located in
120 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g. 121 Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
121 $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux 122 $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
122 123
123Again, reference the "`Installed Standard SDK Directory 124Again, reference the
124Structure <#sdk-installed-standard-sdk-directory-structure>`__" section 125":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
125for more details on the resulting directory structure of the installed 126section for more details on the resulting directory structure of the installed
126SDK. 127SDK.
127 128
128Running the SDK Environment Setup Script 129Running the SDK Environment Setup Script
@@ -147,7 +148,6 @@ script is for an IA-based target machine using i586 tuning:
147 148
148When you run the 149When you run the
149setup script, the same environment variables are defined as are when you 150setup script, the same environment variables are defined as are when you
150run the setup script for an extensible SDK. See the "`Running the 151run the setup script for an extensible SDK. See the
151Extensible SDK Environment Setup 152":ref:`sdk-manual/appendix-obtain:installed extensible sdk directory structure`"
152Script <#sdk-running-the-extensible-sdk-environment-setup-script>`__"
153section for more information. 153section for more information.