summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:42 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commit79fecb25e15178ad1a0f56233a2d514340c14ab5 (patch)
treed15c56dd306be00c8fe441de50d8e123671380fb /documentation/ref-manual
parent3240a59758e918afa79d14c961492d6f98cc3d85 (diff)
downloadpoky-79fecb25e15178ad1a0f56233a2d514340c14ab5.tar.gz
sdk-manual: remove 'sdk' from filenames
All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: bd8c0f7fc09a39a8bbde1c05b51693955738e148) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/migration-2.1.rst6
-rw-r--r--documentation/ref-manual/ref-classes.rst4
-rw-r--r--documentation/ref-manual/ref-devtool-reference.rst4
-rw-r--r--documentation/ref-manual/ref-features.rst2
-rw-r--r--documentation/ref-manual/ref-structure.rst2
-rw-r--r--documentation/ref-manual/ref-variables.rst20
6 files changed, 19 insertions, 19 deletions
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst
index 678a767e15..a1d7b9a2da 100644
--- a/documentation/ref-manual/migration-2.1.rst
+++ b/documentation/ref-manual/migration-2.1.rst
@@ -231,8 +231,8 @@ ADT Removed
231 231
232The Application Development Toolkit (ADT) has been removed because its 232The Application Development Toolkit (ADT) has been removed because its
233functionality almost completely overlapped with the :ref:`standard 233functionality almost completely overlapped with the :ref:`standard
234SDK <sdk-manual/sdk-using:using the standard sdk>` and the 234SDK <sdk-manual/using:using the standard sdk>` and the
235:ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For 235:ref:`extensible SDK <sdk-manual/extensible:using the extensible sdk>`. For
236information on these SDKs and how to build and use them, see the 236information on these SDKs and how to build and use them, see the
237:doc:`/sdk-manual/index` manual. 237:doc:`/sdk-manual/index` manual.
238 238
@@ -386,7 +386,7 @@ These additional changes exist:
386 removed at runtime). 386 removed at runtime).
387 387
388- The 388- The
389 :ref:`devtool modify <sdk-manual/sdk-extensible:use \`\`devtool modify\`\` to modify the source of an existing component>` 389 :ref:`devtool modify <sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component>`
390 command now defaults to extracting the source since that is most 390 command now defaults to extracting the source since that is most
391 commonly expected. The "-x" or "--extract" options are now no-ops. If 391 commonly expected. The "-x" or "--extract" options are now no-ops. If
392 you wish to provide your own existing source tree, you will now need 392 you wish to provide your own existing source tree, you will now need
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index 900341e5ac..37ab4992eb 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -1986,7 +1986,7 @@ files.
1986The ``populate_sdk`` class provides support for SDK-only recipes. For 1986The ``populate_sdk`` class provides support for SDK-only recipes. For
1987information on advantages gained when building a cross-development 1987information on advantages gained when building a cross-development
1988toolchain using the :ref:`ref-tasks-populate_sdk` 1988toolchain using the :ref:`ref-tasks-populate_sdk`
1989task, see the ":ref:`sdk-manual/sdk-appendix-obtain:building an sdk installer`" 1989task, see the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`"
1990section in the Yocto Project Application Development and the Extensible 1990section in the Yocto Project Application Development and the Extensible
1991Software Development Kit (eSDK) manual. 1991Software Development Kit (eSDK) manual.
1992 1992
@@ -2044,7 +2044,7 @@ section in the Yocto Project Overview and Concepts Manual. For
2044information on advantages gained when building a cross-development 2044information on advantages gained when building a cross-development
2045toolchain using the :ref:`ref-tasks-populate_sdk` 2045toolchain using the :ref:`ref-tasks-populate_sdk`
2046task, see the 2046task, see the
2047":ref:`sdk-manual/sdk-appendix-obtain:building an sdk installer`" 2047":ref:`sdk-manual/appendix-obtain:building an sdk installer`"
2048section in the Yocto Project Application Development and the Extensible 2048section in the Yocto Project Application Development and the Extensible
2049Software Development Kit (eSDK) manual. 2049Software Development Kit (eSDK) manual.
2050 2050
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst
index 11b4cb5d5b..2b97bb4605 100644
--- a/documentation/ref-manual/ref-devtool-reference.rst
+++ b/documentation/ref-manual/ref-devtool-reference.rst
@@ -11,7 +11,7 @@ is a key part of the extensible SDK.
11 11
12This chapter provides a Quick Reference for the ``devtool`` command. For 12This chapter provides a Quick Reference for the ``devtool`` command. For
13more information on how to apply the command when using the extensible 13more information on how to apply the command when using the extensible
14SDK, see the ":doc:`/sdk-manual/sdk-extensible`" chapter in the Yocto 14SDK, see the ":doc:`/sdk-manual/extensible`" chapter in the Yocto
15Project Application Development and the Extensible Software Development 15Project Application Development and the Extensible Software Development
16Kit (eSDK) manual. 16Kit (eSDK) manual.
17 17
@@ -438,7 +438,7 @@ revision to which you want to upgrade (i.e. the
438forth. 438forth.
439 439
440You can read more on the ``devtool upgrade`` workflow in the 440You can read more on the ``devtool upgrade`` workflow in the
441":ref:`sdk-manual/sdk-extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" 441":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`"
442section in the Yocto Project Application Development and the Extensible 442section in the Yocto Project Application Development and the Extensible
443Software Development Kit (eSDK) manual. You can also see an example of 443Software Development Kit (eSDK) manual. You can also see an example of
444how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``" 444how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``"
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst
index cb4b57436d..89c06eb65f 100644
--- a/documentation/ref-manual/ref-features.rst
+++ b/documentation/ref-manual/ref-features.rst
@@ -118,7 +118,7 @@ metadata:
118- *api-documentation:* Enables generation of API documentation during 118- *api-documentation:* Enables generation of API documentation during
119 recipe builds. The resulting documentation is added to SDK tarballs 119 recipe builds. The resulting documentation is added to SDK tarballs
120 when the ``bitbake -c populate_sdk`` command is used. See the 120 when the ``bitbake -c populate_sdk`` command is used. See the
121 ":ref:`sdk-manual/sdk-appendix-customizing-standard:adding api documentation to the standard sdk`" 121 ":ref:`sdk-manual/appendix-customizing-standard:adding api documentation to the standard sdk`"
122 section in the Yocto Project Application Development and the 122 section in the Yocto Project Application Development and the
123 Extensible Software Development Kit (eSDK) manual. 123 Extensible Software Development Kit (eSDK) manual.
124 124
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index 606a77c7fa..ab9075b9c5 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -477,7 +477,7 @@ the kernel files:
477The OpenEmbedded build system creates this directory to hold toolchain 477The OpenEmbedded build system creates this directory to hold toolchain
478installer scripts which, when executed, install the sysroot that matches 478installer scripts which, when executed, install the sysroot that matches
479your target hardware. You can find out more about these installers in 479your target hardware. You can find out more about these installers in
480the ":ref:`sdk-manual/sdk-appendix-obtain:building an sdk installer`" 480the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`"
481section in the Yocto Project Application Development and the Extensible 481section in the Yocto Project Application Development and the Extensible
482Software Development Kit (eSDK) manual. 482Software Development Kit (eSDK) manual.
483 483
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index a8a949b92a..865d17c1fc 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -6542,7 +6542,7 @@ system and gives an overview of their function and contents.
6542 6542
6543 For additional information on how to customize the extensible SDK's 6543 For additional information on how to customize the extensible SDK's
6544 configuration, see the 6544 configuration, see the
6545 ":ref:`sdk-manual/sdk-appendix-customizing:configuring the extensible sdk`" 6545 ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
6546 section in the Yocto Project Application Development and the 6546 section in the Yocto Project Application Development and the
6547 Extensible Software Development Kit (eSDK) manual. 6547 Extensible Software Development Kit (eSDK) manual.
6548 6548
@@ -6568,7 +6568,7 @@ system and gives an overview of their function and contents.
6568 6568
6569 For additional information on how to customize the extensible SDK's 6569 For additional information on how to customize the extensible SDK's
6570 configuration, see the 6570 configuration, see the
6571 ":ref:`sdk-manual/sdk-appendix-customizing:configuring the extensible sdk`" 6571 ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
6572 section in the Yocto Project Application Development and the 6572 section in the Yocto Project Application Development and the
6573 Extensible Software Development Kit (eSDK) manual. 6573 Extensible Software Development Kit (eSDK) manual.
6574 6574
@@ -6587,7 +6587,7 @@ system and gives an overview of their function and contents.
6587 6587
6588 For additional information on how to customize the extensible SDK's 6588 For additional information on how to customize the extensible SDK's
6589 configuration, see the 6589 configuration, see the
6590 ":ref:`sdk-manual/sdk-appendix-customizing:configuring the extensible sdk`" 6590 ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`"
6591 section in the Yocto Project Application Development and the 6591 section in the Yocto Project Application Development and the
6592 Extensible Software Development Kit (eSDK) manual. 6592 Extensible Software Development Kit (eSDK) manual.
6593 6593
@@ -6710,7 +6710,7 @@ system and gives an overview of their function and contents.
6710 ``SDK_TITLE`` is set to "Poky (Yocto Project Reference Distro)". 6710 ``SDK_TITLE`` is set to "Poky (Yocto Project Reference Distro)".
6711 6711
6712 For information on how to change this default title, see the 6712 For information on how to change this default title, see the
6713 ":ref:`sdk-manual/sdk-appendix-customizing:changing the extensible sdk installer title`" 6713 ":ref:`sdk-manual/appendix-customizing:changing the extensible sdk installer title`"
6714 section in the Yocto Project Application Development and the 6714 section in the Yocto Project Application Development and the
6715 Extensible Software Development Kit (eSDK) manual. 6715 Extensible Software Development Kit (eSDK) manual.
6716 6716
@@ -6748,7 +6748,7 @@ system and gives an overview of their function and contents.
6748 default distribution "poky", the ``SDKEXTPATH`` is set to "poky_sdk". 6748 default distribution "poky", the ``SDKEXTPATH`` is set to "poky_sdk".
6749 6749
6750 For information on how to change this default directory, see the 6750 For information on how to change this default directory, see the
6751 ":ref:`sdk-manual/sdk-appendix-customizing:changing the default sdk installation directory`" 6751 ":ref:`sdk-manual/appendix-customizing:changing the default sdk installation directory`"
6752 section in the Yocto Project Application Development and the 6752 section in the Yocto Project Application Development and the
6753 Extensible Software Development Kit (eSDK) manual. 6753 Extensible Software Development Kit (eSDK) manual.
6754 6754
@@ -7314,7 +7314,7 @@ system and gives an overview of their function and contents.
7314 7314
7315 For information on how staging for recipe-specific sysroots occurs, 7315 For information on how staging for recipe-specific sysroots occurs,
7316 see the :ref:`ref-tasks-populate_sysroot` 7316 see the :ref:`ref-tasks-populate_sysroot`
7317 task, the ":ref:`sdk-manual/sdk-extensible:sharing files between recipes`" 7317 task, the ":ref:`sdk-manual/extensible:sharing files between recipes`"
7318 section in the Yocto Project Development Tasks Manual, the 7318 section in the Yocto Project Development Tasks Manual, the
7319 ":ref:`overview-manual/concepts:configuration, compilation, and staging`" 7319 ":ref:`overview-manual/concepts:configuration, compilation, and staging`"
7320 section in the Yocto Project Overview and Concepts Manual, and the 7320 section in the Yocto Project Overview and Concepts Manual, and the
@@ -8145,13 +8145,13 @@ system and gives an overview of their function and contents.
8145 In this case, a default list of packages is 8145 In this case, a default list of packages is
8146 set in this variable, but you can add additional packages to the 8146 set in this variable, but you can add additional packages to the
8147 list. See the 8147 list. See the
8148 ":ref:`sdk-manual/sdk-appendix-customizing-standard:adding individual packages to the standard sdk`" section 8148 ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section
8149 in the Yocto Project Application Development and the Extensible 8149 in the Yocto Project Application Development and the Extensible
8150 Software Development Kit (eSDK) manual for more information. 8150 Software Development Kit (eSDK) manual for more information.
8151 8151
8152 For background information on cross-development toolchains in the 8152 For background information on cross-development toolchains in the
8153 Yocto Project development environment, see the 8153 Yocto Project development environment, see the
8154 ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" 8154 ":ref:`sdk-manual/intro:the cross-development toolchain`"
8155 section in the Yocto Project Overview and Concepts Manual. For 8155 section in the Yocto Project Overview and Concepts Manual. For
8156 information on setting up a cross-development environment, see the 8156 information on setting up a cross-development environment, see the
8157 :doc:`/sdk-manual/index` manual. 8157 :doc:`/sdk-manual/index` manual.
@@ -8175,13 +8175,13 @@ system and gives an overview of their function and contents.
8175 target hardware), which includes libraries and headers. Use this 8175 target hardware), which includes libraries and headers. Use this
8176 variable to add individual packages to the part of the SDK that runs 8176 variable to add individual packages to the part of the SDK that runs
8177 on the target. See the 8177 on the target. See the
8178 ":ref:`sdk-manual/sdk-appendix-customizing-standard:adding individual packages to the standard sdk`" section 8178 ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section
8179 in the Yocto Project Application Development and the Extensible 8179 in the Yocto Project Application Development and the Extensible
8180 Software Development Kit (eSDK) manual for more information. 8180 Software Development Kit (eSDK) manual for more information.
8181 8181
8182 For background information on cross-development toolchains in the 8182 For background information on cross-development toolchains in the
8183 Yocto Project development environment, see the 8183 Yocto Project development environment, see the
8184 ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" 8184 ":ref:`sdk-manual/intro:the cross-development toolchain`"
8185 section in the Yocto Project Overview and Concepts Manual. For 8185 section in the Yocto Project Overview and Concepts Manual. For
8186 information on setting up a cross-development environment, see the 8186 information on setting up a cross-development environment, see the
8187 :doc:`/sdk-manual/index` manual. 8187 :doc:`/sdk-manual/index` manual.