summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:38 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commitaf6f5d821d39b50c3c4b45a593324346fce0d723 (patch)
tree872369e16adfff81fc49b7e8f550cae8905916b7 /documentation
parentc684a7a6d50754d577e0ff68a6fb6ed493b8f93e (diff)
downloadpoky-af6f5d821d39b50c3c4b45a593324346fce0d723.tar.gz
dev-manual: remove 'dev-manual' 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: 00a9244587e2e63f2a5197ed0dfc89cb330f9275) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/index.rst14
-rw-r--r--documentation/bsp-guide/bsp.rst36
-rw-r--r--documentation/dev-manual/common-tasks.rst (renamed from documentation/dev-manual/dev-manual-common-tasks.rst)54
-rw-r--r--documentation/dev-manual/index.rst8
-rw-r--r--documentation/dev-manual/intro.rst (renamed from documentation/dev-manual/dev-manual-intro.rst)0
-rw-r--r--documentation/dev-manual/qemu.rst (renamed from documentation/dev-manual/dev-manual-qemu.rst)0
-rw-r--r--documentation/dev-manual/start.rst (renamed from documentation/dev-manual/dev-manual-start.rst)20
-rw-r--r--documentation/kernel-dev/kernel-dev-common.rst26
-rw-r--r--documentation/kernel-dev/kernel-dev-faq.rst2
-rw-r--r--documentation/kernel-dev/kernel-dev-intro.rst4
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst20
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst26
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst16
-rw-r--r--documentation/ref-manual/faq.rst6
-rw-r--r--documentation/ref-manual/migration-1.4.rst2
-rw-r--r--documentation/ref-manual/migration-1.5.rst4
-rw-r--r--documentation/ref-manual/migration-1.6.rst6
-rw-r--r--documentation/ref-manual/migration-1.7.rst2
-rw-r--r--documentation/ref-manual/migration-2.1.rst2
-rw-r--r--documentation/ref-manual/migration-2.3.rst2
-rw-r--r--documentation/ref-manual/migration-2.5.rst2
-rw-r--r--documentation/ref-manual/migration-2.6.rst2
-rw-r--r--documentation/ref-manual/ref-classes.rst34
-rw-r--r--documentation/ref-manual/ref-devtool-reference.rst4
-rw-r--r--documentation/ref-manual/ref-features.rst6
-rw-r--r--documentation/ref-manual/ref-images.rst4
-rw-r--r--documentation/ref-manual/ref-kickstart.rst2
-rw-r--r--documentation/ref-manual/ref-release-process.rst6
-rw-r--r--documentation/ref-manual/ref-structure.rst14
-rw-r--r--documentation/ref-manual/ref-system-requirements.rst2
-rw-r--r--documentation/ref-manual/ref-tasks.rst10
-rw-r--r--documentation/ref-manual/ref-terms.rst4
-rw-r--r--documentation/ref-manual/ref-variables.rst104
-rw-r--r--documentation/ref-manual/resources.rst4
-rw-r--r--documentation/sdk-manual/sdk-appendix-obtain.rst8
-rw-r--r--documentation/sdk-manual/sdk-intro.rst2
-rw-r--r--documentation/test-manual/intro.rst2
-rw-r--r--documentation/toaster-manual/reference.rst2
-rw-r--r--documentation/toaster-manual/start.rst2
-rw-r--r--documentation/transitioning-to-a-custom-environment.rst8
-rw-r--r--documentation/what-i-wish-id-known.rst2
41 files changed, 237 insertions, 237 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index c1b78d0f59..51f684af01 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -20,7 +20,7 @@ build a reference embedded OS called Poky.
20 (:term:`Build Host`) is not 20 (:term:`Build Host`) is not
21 a native Linux system, you can still perform these steps by using 21 a native Linux system, you can still perform these steps by using
22 CROss PlatformS (CROPS) and setting up a Poky container. See the 22 CROss PlatformS (CROPS) and setting up a Poky container. See the
23 :ref:`dev-manual/dev-manual-start:setting up to use cross platforms (crops)` 23 :ref:`dev-manual/start:setting up to use cross platforms (crops)`
24 section 24 section
25 in the Yocto Project Development Tasks Manual for more 25 in the Yocto Project Development Tasks Manual for more
26 information. 26 information.
@@ -34,7 +34,7 @@ build a reference embedded OS called Poky.
34 compatible but not officially supported nor validated with 34 compatible but not officially supported nor validated with
35 WSLv2, if you still decide to use WSL please upgrade to WSLv2. 35 WSLv2, if you still decide to use WSL please upgrade to WSLv2.
36 36
37 See the :ref:`dev-manual/dev-manual-start:setting up to use windows 37 See the :ref:`dev-manual/start:setting up to use windows
38 subsystem for linux (wslv2)` section in the Yocto Project Development 38 subsystem for linux (wslv2)` section in the Yocto Project Development
39 Tasks Manual for more information. 39 Tasks Manual for more information.
40 40
@@ -55,7 +55,7 @@ following requirements:
55 :ref:`ref-manual/ref-system-requirements:supported linux distributions` 55 :ref:`ref-manual/ref-system-requirements:supported linux distributions`
56 section in the Yocto Project Reference Manual. For detailed 56 section in the Yocto Project Reference Manual. For detailed
57 information on preparing your build host, see the 57 information on preparing your build host, see the
58 :ref:`dev-manual/dev-manual-start:preparing the build host` 58 :ref:`dev-manual/start:preparing the build host`
59 section in the Yocto Project Development Tasks Manual. 59 section in the Yocto Project Development Tasks Manual.
60 60
61- 61-
@@ -145,7 +145,7 @@ branch at the time of the Yocto Project &DISTRO_REL_TAG; release.
145 145
146For more options and information about accessing Yocto Project related 146For more options and information about accessing Yocto Project related
147repositories, see the 147repositories, see the
148:ref:`dev-manual/dev-manual-start:locating yocto project source files` 148:ref:`dev-manual/start:locating yocto project source files`
149section in the Yocto Project Development Tasks Manual. 149section in the Yocto Project Development Tasks Manual.
150 150
151Building Your Image 151Building Your Image
@@ -257,7 +257,7 @@ an entire Linux distribution, including the toolchain, from source.
257 $ runqemu qemux86-64 257 $ runqemu qemux86-64
258 258
259 If you want to learn more about running QEMU, see the 259 If you want to learn more about running QEMU, see the
260 :ref:`dev-manual/dev-manual-qemu:using the quick emulator (qemu)` chapter in 260 :ref:`dev-manual/qemu:using the quick emulator (qemu)` chapter in
261 the Yocto Project Development Tasks Manual. 261 the Yocto Project Development Tasks Manual.
262 262
263#. **Exit QEMU:** Exit QEMU by either clicking on the shutdown icon or by typing 263#. **Exit QEMU:** Exit QEMU by either clicking on the shutdown icon or by typing
@@ -346,7 +346,7 @@ Follow these steps to add a hardware layer:
346 346
347 You can find 347 You can find
348 more information on adding layers in the 348 more information on adding layers in the
349 :ref:`dev-manual/dev-manual-common-tasks:adding a layer using the \`\`bitbake-layers\`\` script` 349 :ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`
350 section. 350 section.
351 351
352Completing these steps has added the ``meta-altera`` layer to your Yocto 352Completing these steps has added the ``meta-altera`` layer to your Yocto
@@ -381,7 +381,7 @@ The following commands run the tool to create a layer named
381 381
382For more information 382For more information
383on layers and how to create them, see the 383on layers and how to create them, see the
384:ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script` 384:ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`
385section in the Yocto Project Development Tasks Manual. 385section in the Yocto Project Development Tasks Manual.
386 386
387Where To Go Next 387Where To Go Next
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 357e740a5c..6d3ccd49b3 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -72,7 +72,7 @@ For information on typical BSP development workflow, see the
72section. For more 72section. For more
73information on how to set up a local copy of source files from a Git 73information on how to set up a local copy of source files from a Git
74repository, see the 74repository, see the
75:ref:`dev-manual/dev-manual-start:locating yocto project source files` 75:ref:`dev-manual/start:locating yocto project source files`
76section in the Yocto Project Development Tasks Manual. 76section in the Yocto Project Development Tasks Manual.
77 77
78The BSP layer's base directory (``meta-bsp_root_name``) is the root 78The BSP layer's base directory (``meta-bsp_root_name``) is the root
@@ -128,7 +128,7 @@ you want to work with, such as: ::
128and so on. 128and so on.
129 129
130For more information on layers, see the 130For more information on layers, see the
131":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 131":ref:`dev-manual/common-tasks:understanding and creating layers`"
132section of the Yocto Project Development Tasks Manual. 132section of the Yocto Project Development Tasks Manual.
133 133
134Preparing Your Build Host to Work With BSP Layers 134Preparing Your Build Host to Work With BSP Layers
@@ -146,7 +146,7 @@ section.
146 :ref:`bsp-guide/bsp:example filesystem layout` section. 146 :ref:`bsp-guide/bsp:example filesystem layout` section.
147 147
148#. *Set Up the Build Environment:* Be sure you are set up to use BitBake 148#. *Set Up the Build Environment:* Be sure you are set up to use BitBake
149 in a shell. See the ":ref:`dev-manual/dev-manual-start:preparing the build host`" 149 in a shell. See the ":ref:`dev-manual/start:preparing the build host`"
150 section in the Yocto Project Development Tasks Manual for information on how 150 section in the Yocto Project Development Tasks Manual for information on how
151 to get a build host ready that is either a native Linux machine or a machine 151 to get a build host ready that is either a native Linux machine or a machine
152 that uses CROPS. 152 that uses CROPS.
@@ -154,10 +154,10 @@ section.
154#. *Clone the poky Repository:* You need to have a local copy of the 154#. *Clone the poky Repository:* You need to have a local copy of the
155 Yocto Project :term:`Source Directory` (i.e. a local 155 Yocto Project :term:`Source Directory` (i.e. a local
156 ``poky`` repository). See the 156 ``poky`` repository). See the
157 ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" and 157 ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" and
158 possibly the 158 possibly the
159 ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" or 159 ":ref:`dev-manual/start:checking out by branch in poky`" or
160 ":ref:`dev-manual/dev-manual-start:checking out by tag in poky`" 160 ":ref:`dev-manual/start:checking out by tag in poky`"
161 sections 161 sections
162 all in the Yocto Project Development Tasks Manual for information on 162 all in the Yocto Project Development Tasks Manual for information on
163 how to clone the ``poky`` repository and check out the appropriate 163 how to clone the ``poky`` repository and check out the appropriate
@@ -205,7 +205,7 @@ section.
205 205
206 To see the available branch names in a cloned repository, use the ``git 206 To see the available branch names in a cloned repository, use the ``git
207 branch -al`` command. See the 207 branch -al`` command. See the
208 ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" 208 ":ref:`dev-manual/start:checking out by branch in poky`"
209 section in the Yocto Project Development Tasks Manual for more 209 section in the Yocto Project Development Tasks Manual for more
210 information. 210 information.
211 211
@@ -463,7 +463,7 @@ requirements are handled with the ``COPYING.MIT`` file.
463Licensing files can be MIT, BSD, GPLv*, and so forth. These files are 463Licensing files can be MIT, BSD, GPLv*, and so forth. These files are
464recommended for the BSP but are optional and totally up to the BSP 464recommended for the BSP but are optional and totally up to the BSP
465developer. For information on how to maintain license compliance, see 465developer. For information on how to maintain license compliance, see
466the ":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" 466the ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
467section in the Yocto Project Development Tasks Manual. 467section in the Yocto Project Development Tasks Manual.
468 468
469README File 469README File
@@ -589,7 +589,7 @@ filenames correspond to the values to which users have set the
589 589
590These files define things such as the kernel package to use 590These files define things such as the kernel package to use
591(:term:`PREFERRED_PROVIDER` of 591(:term:`PREFERRED_PROVIDER` of
592:ref:`virtual/kernel <dev-manual/dev-manual-common-tasks:using virtual providers>`), 592:ref:`virtual/kernel <dev-manual/common-tasks:using virtual providers>`),
593the hardware drivers to include in different types of images, any 593the hardware drivers to include in different types of images, any
594special software components that are needed, any bootloader information, 594special software components that are needed, any bootloader information,
595and also any special image format requirements. 595and also any special image format requirements.
@@ -726,7 +726,7 @@ workflow.
726 :align: center 726 :align: center
727 727
728#. *Set up Your Host Development System to Support Development Using the 728#. *Set up Your Host Development System to Support Development Using the
729 Yocto Project*: See the ":ref:`dev-manual/dev-manual-start:preparing the build host`" 729 Yocto Project*: See the ":ref:`dev-manual/start:preparing the build host`"
730 section in the Yocto Project Development Tasks Manual for options on how to 730 section in the Yocto Project Development Tasks Manual for options on how to
731 get a system ready to use the Yocto Project. 731 get a system ready to use the Yocto Project.
732 732
@@ -756,7 +756,7 @@ workflow.
756 OpenEmbedded build system knows about. For more information on 756 OpenEmbedded build system knows about. For more information on
757 layers, see the ":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`" 757 layers, see the ":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`"
758 section in the Yocto Project Overview and Concepts Manual. You can also 758 section in the Yocto Project Overview and Concepts Manual. You can also
759 reference the ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 759 reference the ":ref:`dev-manual/common-tasks:understanding and creating layers`"
760 section in the Yocto Project Development Tasks Manual. For more 760 section in the Yocto Project Development Tasks Manual. For more
761 information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" 761 information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`"
762 section. 762 section.
@@ -815,7 +815,7 @@ workflow.
815 key configuration files are configured appropriately: the 815 key configuration files are configured appropriately: the
816 ``conf/local.conf`` and the ``conf/bblayers.conf`` file. You must 816 ``conf/local.conf`` and the ``conf/bblayers.conf`` file. You must
817 make the OpenEmbedded build system aware of your new layer. See the 817 make the OpenEmbedded build system aware of your new layer. See the
818 ":ref:`dev-manual/dev-manual-common-tasks:enabling your layer`" 818 ":ref:`dev-manual/common-tasks:enabling your layer`"
819 section in the Yocto Project Development Tasks Manual for information 819 section in the Yocto Project Development Tasks Manual for information
820 on how to let the build system know about your new layer. 820 on how to let the build system know about your new layer.
821 821
@@ -846,7 +846,7 @@ Before looking at BSP requirements, you should consider the following:
846 layer that can be added to the Yocto Project. For guidelines on 846 layer that can be added to the Yocto Project. For guidelines on
847 creating a layer that meets these base requirements, see the 847 creating a layer that meets these base requirements, see the
848 ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the 848 ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the
849 ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 849 ":ref:`dev-manual/common-tasks:understanding and creating layers`"
850 section in the Yocto Project Development Tasks Manual. 850 section in the Yocto Project Development Tasks Manual.
851 851
852- The requirements in this section apply regardless of how you package 852- The requirements in this section apply regardless of how you package
@@ -928,7 +928,7 @@ Yocto Project:
928 - The name and contact information for the BSP layer maintainer. 928 - The name and contact information for the BSP layer maintainer.
929 This is the person to whom patches and questions should be sent. 929 This is the person to whom patches and questions should be sent.
930 For information on how to find the right person, see the 930 For information on how to find the right person, see the
931 ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" 931 ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`"
932 section in the Yocto Project Development Tasks Manual. 932 section in the Yocto Project Development Tasks Manual.
933 933
934 - Instructions on how to build the BSP using the BSP layer. 934 - Instructions on how to build the BSP using the BSP layer.
@@ -1013,7 +1013,7 @@ If you plan on customizing a recipe for a particular BSP, you need to do
1013the following: 1013the following:
1014 1014
1015- Create a ``*.bbappend`` file for the modified recipe. For information on using 1015- Create a ``*.bbappend`` file for the modified recipe. For information on using
1016 append files, see the ":ref:`dev-manual/dev-manual-common-tasks:using 1016 append files, see the ":ref:`dev-manual/common-tasks:using
1017 .bbappend files in your layer`" section in the Yocto Project Development 1017 .bbappend files in your layer`" section in the Yocto Project Development
1018 Tasks Manual. 1018 Tasks Manual.
1019 1019
@@ -1118,7 +1118,7 @@ list describes them in order of preference:
1118 Specifying the matching license string signifies that you agree to 1118 Specifying the matching license string signifies that you agree to
1119 the license. Thus, the build system can build the corresponding 1119 the license. Thus, the build system can build the corresponding
1120 recipe and include the component in the image. See the 1120 recipe and include the component in the image. See the
1121 ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" 1121 ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`"
1122 section in the Yocto Project Development Tasks Manual for details on 1122 section in the Yocto Project Development Tasks Manual for details on
1123 how to use these variables. 1123 how to use these variables.
1124 1124
@@ -1170,7 +1170,7 @@ Use these steps to create a BSP layer:
1170 ``create-layer`` subcommand to create a new general layer. For 1170 ``create-layer`` subcommand to create a new general layer. For
1171 instructions on how to create a general layer using the 1171 instructions on how to create a general layer using the
1172 ``bitbake-layers`` script, see the 1172 ``bitbake-layers`` script, see the
1173 ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" 1173 ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`"
1174 section in the Yocto Project Development Tasks Manual. 1174 section in the Yocto Project Development Tasks Manual.
1175 1175
1176- *Create a Layer Configuration File:* Every layer needs a layer 1176- *Create a Layer Configuration File:* Every layer needs a layer
@@ -1230,7 +1230,7 @@ configuration files is to examine various files for BSP from the
1230:yocto_git:`Source Repositories <>`. 1230:yocto_git:`Source Repositories <>`.
1231 1231
1232For a detailed description of this particular layer configuration file, 1232For a detailed description of this particular layer configuration file,
1233see ":ref:`step 3 <dev-manual/dev-manual-common-tasks:creating your own layer>`" 1233see ":ref:`step 3 <dev-manual/common-tasks:creating your own layer>`"
1234in the discussion that describes how to create layers in the Yocto 1234in the discussion that describes how to create layers in the Yocto
1235Project Development Tasks Manual. 1235Project Development Tasks Manual.
1236 1236
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 0a2e6d9df3..c627491f39 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -31,7 +31,7 @@ layers so that you can better understand them. For information about the
31layer-creation tools, see the 31layer-creation tools, see the
32":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`" 32":ref:`bsp-guide/bsp:creating a new bsp layer using the \`\`bitbake-layers\`\` script`"
33section in the Yocto Project Board Support Package (BSP) Developer's 33section in the Yocto Project Board Support Package (BSP) Developer's
34Guide and the ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" 34Guide and the ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`"
35section further down in this manual. 35section further down in this manual.
36 36
37Follow these general steps to create your layer without using tools: 37Follow these general steps to create your layer without using tools:
@@ -725,7 +725,7 @@ simplifies creating a new general layer.
725 725
726 - In order to use a layer with the OpenEmbedded build system, you 726 - In order to use a layer with the OpenEmbedded build system, you
727 need to add the layer to your ``bblayers.conf`` configuration 727 need to add the layer to your ``bblayers.conf`` configuration
728 file. See the ":ref:`dev-manual/dev-manual-common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" 728 file. See the ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`"
729 section for more information. 729 section for more information.
730 730
731The default mode of the script's operation with this subcommand is to 731The default mode of the script's operation with this subcommand is to
@@ -1106,7 +1106,7 @@ that can help you quickly get a start on a new recipe:
1106.. note:: 1106.. note::
1107 1107
1108 For information on recipe syntax, see the 1108 For information on recipe syntax, see the
1109 ":ref:`dev-manual/dev-manual-common-tasks:recipe syntax`" section. 1109 ":ref:`dev-manual/common-tasks:recipe syntax`" section.
1110 1110
1111Creating the Base Recipe Using ``devtool add`` 1111Creating the Base Recipe Using ``devtool add``
1112~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 1112~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1538,7 +1538,7 @@ variables:
1538 differences result in an error with the message containing the 1538 differences result in an error with the message containing the
1539 current checksum. For more explanation and examples of how to set the 1539 current checksum. For more explanation and examples of how to set the
1540 ``LIC_FILES_CHKSUM`` variable, see the 1540 ``LIC_FILES_CHKSUM`` variable, see the
1541 ":ref:`dev-manual/dev-manual-common-tasks:tracking license changes`" section. 1541 ":ref:`dev-manual/common-tasks:tracking license changes`" section.
1542 1542
1543 To determine the correct checksum string, you can list the 1543 To determine the correct checksum string, you can list the
1544 appropriate files in the ``LIC_FILES_CHKSUM`` variable with incorrect 1544 appropriate files in the ``LIC_FILES_CHKSUM`` variable with incorrect
@@ -1771,7 +1771,7 @@ Here are some common issues that cause failures.
1771 For cases where improper paths are detected for configuration files 1771 For cases where improper paths are detected for configuration files
1772 or for when libraries/headers cannot be found, be sure you are using 1772 or for when libraries/headers cannot be found, be sure you are using
1773 the more robust ``pkg-config``. See the note in section 1773 the more robust ``pkg-config``. See the note in section
1774 ":ref:`dev-manual/dev-manual-common-tasks:Configuring the Recipe`" for additional information. 1774 ":ref:`dev-manual/common-tasks:Configuring the Recipe`" for additional information.
1775 1775
1776- *Parallel build failures:* These failures manifest themselves as 1776- *Parallel build failures:* These failures manifest themselves as
1777 intermittent errors, or errors reporting that a file or directory 1777 intermittent errors, or errors reporting that a file or directory
@@ -2338,7 +2338,7 @@ Following is one example: (``hello_2.3.bb``)
2338 2338
2339The variable ``LIC_FILES_CHKSUM`` is used to track source license 2339The variable ``LIC_FILES_CHKSUM`` is used to track source license
2340changes as described in the 2340changes as described in the
2341":ref:`dev-manual/dev-manual-common-tasks:tracking license changes`" section in 2341":ref:`dev-manual/common-tasks:tracking license changes`" section in
2342the Yocto Project Overview and Concepts Manual. You can quickly create 2342the Yocto Project Overview and Concepts Manual. You can quickly create
2343Autotool-based recipes in a manner similar to the previous example. 2343Autotool-based recipes in a manner similar to the previous example.
2344 2344
@@ -2963,7 +2963,7 @@ The following steps describe how to set up the AUH utility:
29631. *Be Sure the Development Host is Set Up:* You need to be sure that 29631. *Be Sure the Development Host is Set Up:* You need to be sure that
2964 your development host is set up to use the Yocto Project. For 2964 your development host is set up to use the Yocto Project. For
2965 information on how to set up your host, see the 2965 information on how to set up your host, see the
2966 ":ref:`dev-manual/dev-manual-start:Preparing the Build Host`" section. 2966 ":ref:`dev-manual/start:Preparing the Build Host`" section.
2967 2967
29682. *Make Sure Git is Configured:* The AUH utility requires Git to be 29682. *Make Sure Git is Configured:* The AUH utility requires Git to be
2969 configured because AUH uses Git to save upgrades. Thus, you must have 2969 configured because AUH uses Git to save upgrades. Thus, you must have
@@ -3015,7 +3015,7 @@ The following steps describe how to set up the AUH utility:
3015 configurations: 3015 configurations:
3016 3016
3017 - If you want to enable :ref:`Build 3017 - If you want to enable :ref:`Build
3018 History <dev-manual/dev-manual-common-tasks:maintaining build output quality>`, 3018 History <dev-manual/common-tasks:maintaining build output quality>`,
3019 which is optional, you need the following lines in the 3019 which is optional, you need the following lines in the
3020 ``conf/local.conf`` file: 3020 ``conf/local.conf`` file:
3021 :: 3021 ::
@@ -3267,8 +3267,8 @@ Manually Upgrading a Recipe
3267--------------------------- 3267---------------------------
3268 3268
3269If for some reason you choose not to upgrade recipes using 3269If for some reason you choose not to upgrade recipes using
3270:ref:`dev-manual/dev-manual-common-tasks:Using the Auto Upgrade Helper (AUH)` or 3270:ref:`dev-manual/common-tasks:Using the Auto Upgrade Helper (AUH)` or
3271by :ref:`dev-manual/dev-manual-common-tasks:Using \`\`devtool upgrade\`\``, 3271by :ref:`dev-manual/common-tasks:Using \`\`devtool upgrade\`\``,
3272you can manually edit the recipe files to upgrade the versions. 3272you can manually edit the recipe files to upgrade the versions.
3273 3273
3274.. note:: 3274.. note::
@@ -3467,7 +3467,7 @@ Follow these general steps:
3467 (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). 3467 (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``).
3468 Modifications will also disappear if you use the ``rm_work`` feature as 3468 Modifications will also disappear if you use the ``rm_work`` feature as
3469 described in the 3469 described in the
3470 ":ref:`dev-manual/dev-manual-common-tasks:conserving disk space during builds`" 3470 ":ref:`dev-manual/common-tasks:conserving disk space during builds`"
3471 section. 3471 section.
3472 3472
34737. *Generate the Patch:* Once your changes work as expected, you need to 34737. *Generate the Patch:* Once your changes work as expected, you need to
@@ -3667,7 +3667,7 @@ The following figure and list overviews the build process:
3667 :align: center 3667 :align: center
3668 3668
36691. *Set up Your Host Development System to Support Development Using the 36691. *Set up Your Host Development System to Support Development Using the
3670 Yocto Project*: See the ":doc:`dev-manual-start`" section for options on how to get a 3670 Yocto Project*: See the ":doc:`start`" section for options on how to get a
3671 build host ready to use the Yocto Project. 3671 build host ready to use the Yocto Project.
3672 3672
36732. *Initialize the Build Environment:* Initialize the build environment 36732. *Initialize the Build Environment:* Initialize the build environment
@@ -4046,7 +4046,7 @@ your own distribution that are likely modeled after ``poky-tiny``.
4046 4046
4047 To use ``poky-tiny`` in your build, set the ``DISTRO`` variable in your 4047 To use ``poky-tiny`` in your build, set the ``DISTRO`` variable in your
4048 ``local.conf`` file to "poky-tiny" as described in the 4048 ``local.conf`` file to "poky-tiny" as described in the
4049 ":ref:`dev-manual/dev-manual-common-tasks:creating your own distribution`" 4049 ":ref:`dev-manual/common-tasks:creating your own distribution`"
4050 section. 4050 section.
4051 4051
4052Understanding some memory concepts will help you reduce the system size. 4052Understanding some memory concepts will help you reduce the system size.
@@ -5736,7 +5736,7 @@ or ::
5736 5736
5737 For more information on how to use the ``bmaptool`` 5737 For more information on how to use the ``bmaptool``
5738 to flash a device with an image, see the 5738 to flash a device with an image, see the
5739 ":ref:`dev-manual/dev-manual-common-tasks:flashing images using \`\`bmaptool\`\``" 5739 ":ref:`dev-manual/common-tasks:flashing images using \`\`bmaptool\`\``"
5740 section. 5740 section.
5741 5741
5742Using a Modified Kickstart File 5742Using a Modified Kickstart File
@@ -5956,7 +5956,7 @@ the existing kernel, and then inserts a new kernel:
5956 5956
5957 Once the new kernel is added back into the image, you can use the 5957 Once the new kernel is added back into the image, you can use the
5958 ``dd`` command or :ref:`bmaptool 5958 ``dd`` command or :ref:`bmaptool
5959 <dev-manual/dev-manual-common-tasks:flashing images using \`\`bmaptool\`\`>` 5959 <dev-manual/common-tasks:flashing images using \`\`bmaptool\`\`>`
5960 to flash your wic image onto an SD card or USB stick and test your 5960 to flash your wic image onto an SD card or USB stick and test your
5961 target. 5961 target.
5962 5962
@@ -6202,7 +6202,7 @@ layer. The following steps provide some more detail:
6202 just placing configurations in a ``local.conf`` configuration file 6202 just placing configurations in a ``local.conf`` configuration file
6203 makes it easier to reproduce the same build configuration when using 6203 makes it easier to reproduce the same build configuration when using
6204 multiple build machines. See the 6204 multiple build machines. See the
6205 ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" 6205 ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`"
6206 section for information on how to quickly set up a layer. 6206 section for information on how to quickly set up a layer.
6207 6207
6208- *Create the distribution configuration file:* The distribution 6208- *Create the distribution configuration file:* The distribution
@@ -7979,7 +7979,7 @@ associated ``EXTRA_IMAGE_FEATURES`` variable, as in:
7979 EXTRA_IMAGE_FEATURES = "read-only-rootfs" 7979 EXTRA_IMAGE_FEATURES = "read-only-rootfs"
7980 7980
7981For more information on how to use these variables, see the 7981For more information on how to use these variables, see the
7982":ref:`dev-manual/dev-manual-common-tasks:Customizing Images Using Custom \`\`IMAGE_FEATURES\`\` and \`\`EXTRA_IMAGE_FEATURES\`\``" 7982":ref:`dev-manual/common-tasks:Customizing Images Using Custom \`\`IMAGE_FEATURES\`\` and \`\`EXTRA_IMAGE_FEATURES\`\``"
7983section. For information on the variables, see 7983section. For information on the variables, see
7984:term:`IMAGE_FEATURES` and 7984:term:`IMAGE_FEATURES` and
7985:term:`EXTRA_IMAGE_FEATURES`. 7985:term:`EXTRA_IMAGE_FEATURES`.
@@ -8056,13 +8056,13 @@ the information.
8056 8056
8057The remainder of this section describes the following: 8057The remainder of this section describes the following:
8058 8058
8059- :ref:`How you can enable and disable build history <dev-manual/dev-manual-common-tasks:enabling and disabling build history>` 8059- :ref:`How you can enable and disable build history <dev-manual/common-tasks:enabling and disabling build history>`
8060 8060
8061- :ref:`How to understand what the build history contains <dev-manual/dev-manual-common-tasks:understanding what the build history contains>` 8061- :ref:`How to understand what the build history contains <dev-manual/common-tasks:understanding what the build history contains>`
8062 8062
8063- :ref:`How to limit the information used for build history <dev-manual/dev-manual-common-tasks:using build history to gather image information only>` 8063- :ref:`How to limit the information used for build history <dev-manual/common-tasks:using build history to gather image information only>`
8064 8064
8065- :ref:`How to examine the build history from both a command-line and web interface <dev-manual/dev-manual-common-tasks:examining build history information>` 8065- :ref:`How to examine the build history from both a command-line and web interface <dev-manual/common-tasks:examining build history information>`
8066 8066
8067Enabling and Disabling Build History 8067Enabling and Disabling Build History
8068------------------------------------ 8068------------------------------------
@@ -9084,7 +9084,7 @@ situations.
9084 completes to log error information into a common database, that can 9084 completes to log error information into a common database, that can
9085 help you figure out what might be going wrong. For information on how 9085 help you figure out what might be going wrong. For information on how
9086 to enable and use this feature, see the 9086 to enable and use this feature, see the
9087 ":ref:`dev-manual/dev-manual-common-tasks:using the error reporting tool`" 9087 ":ref:`dev-manual/common-tasks:using the error reporting tool`"
9088 section. 9088 section.
9089 9089
9090The following list shows the debugging topics in the remainder of this 9090The following list shows the debugging topics in the remainder of this
@@ -9100,7 +9100,7 @@ section:
9100 use the BitBake ``-e`` option to examine variable values after a 9100 use the BitBake ``-e`` option to examine variable values after a
9101 recipe has been parsed. 9101 recipe has been parsed.
9102 9102
9103- ":ref:`dev-manual/dev-manual-common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" 9103- ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``"
9104 describes how to use the ``oe-pkgdata-util`` utility to query 9104 describes how to use the ``oe-pkgdata-util`` utility to query
9105 :term:`PKGDATA_DIR` and 9105 :term:`PKGDATA_DIR` and
9106 display package-related information for built packages. 9106 display package-related information for built packages.
@@ -10581,7 +10581,7 @@ Yocto Project Reference Manual.
10581 10581
10582Here is the general procedure on how to submit a patch through email 10582Here is the general procedure on how to submit a patch through email
10583without using the scripts once the steps in 10583without using the scripts once the steps in
10584:ref:`dev-manual/dev-manual-common-tasks:preparing changes for submission` have been followed: 10584:ref:`dev-manual/common-tasks:preparing changes for submission` have been followed:
10585 10585
105861. *Format the Commit:* Format the commit into an email message. To 105861. *Format the Commit:* Format the commit into an email message. To
10587 format commits, use the ``git format-patch`` command. When you 10587 format commits, use the ``git format-patch`` command. When you
@@ -10670,7 +10670,7 @@ and ``send-pull-request`` scripts from openembedded-core to create and send a
10670patch series with a link to the branch for review. 10670patch series with a link to the branch for review.
10671 10671
10672Follow this procedure to push a change to an upstream "contrib" Git 10672Follow this procedure to push a change to an upstream "contrib" Git
10673repository once the steps in :ref:`dev-manual/dev-manual-common-tasks:preparing changes for submission` have 10673repository once the steps in :ref:`dev-manual/common-tasks:preparing changes for submission` have
10674been followed: 10674been followed:
10675 10675
10676.. note:: 10676.. note::
@@ -10845,8 +10845,8 @@ follows:
10845 a newer version of the software which includes an upstream fix for the 10845 a newer version of the software which includes an upstream fix for the
10846 issue or when the issue has been fixed on the master branch in a way 10846 issue or when the issue has been fixed on the master branch in a way
10847 that introduces backwards incompatible changes. In this case follow the 10847 that introduces backwards incompatible changes. In this case follow the
10848 steps in :ref:`dev-manual/dev-manual-common-tasks:preparing changes for submission` and 10848 steps in :ref:`dev-manual/common-tasks:preparing changes for submission` and
10849 :ref:`dev-manual/dev-manual-common-tasks:using email to submit a patch` but modify the subject header of your patch 10849 :ref:`dev-manual/common-tasks:using email to submit a patch` but modify the subject header of your patch
10850 email to include the name of the stable branch which you are 10850 email to include the name of the stable branch which you are
10851 targetting. This can be done using the ``--subject-prefix`` argument to 10851 targetting. This can be done using the ``--subject-prefix`` argument to
10852 ``git format-patch``, for example to submit a patch to the dunfell 10852 ``git format-patch``, for example to submit a patch to the dunfell
diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst
index 8f09224fe8..941db2df8c 100644
--- a/documentation/dev-manual/index.rst
+++ b/documentation/dev-manual/index.rst
@@ -10,10 +10,10 @@ Yocto Project Development Tasks Manual
10 :caption: Table of Contents 10 :caption: Table of Contents
11 :numbered: 11 :numbered:
12 12
13 dev-manual-intro 13 intro
14 dev-manual-start 14 start
15 dev-manual-common-tasks 15 common-tasks
16 dev-manual-qemu 16 qemu
17 history 17 history
18 18
19.. include:: /boilerplate.rst 19.. include:: /boilerplate.rst
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/intro.rst
index 23c848e870..23c848e870 100644
--- a/documentation/dev-manual/dev-manual-intro.rst
+++ b/documentation/dev-manual/intro.rst
diff --git a/documentation/dev-manual/dev-manual-qemu.rst b/documentation/dev-manual/qemu.rst
index 4e58fc1b67..4e58fc1b67 100644
--- a/documentation/dev-manual/dev-manual-qemu.rst
+++ b/documentation/dev-manual/qemu.rst
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/start.rst
index 75b5d7b5f0..85ec97b9e4 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/start.rst
@@ -7,7 +7,7 @@ Setting Up to Use the Yocto Project
7This chapter provides guidance on how to prepare to use the Yocto 7This chapter provides guidance on how to prepare to use the Yocto
8Project. You can learn about creating a team environment to develop 8Project. You can learn about creating a team environment to develop
9using the Yocto Project, how to set up a :ref:`build 9using the Yocto Project, how to set up a :ref:`build
10host <dev-manual/dev-manual-start:preparing the build host>`, how to locate 10host <dev-manual/start:preparing the build host>`, how to locate
11Yocto Project source repositories, and how to create local Git 11Yocto Project source repositories, and how to create local Git
12repositories. 12repositories.
13 13
@@ -224,7 +224,7 @@ particular working environment and set of practices.
224 - Maintain your Metadata in layers that make sense for your 224 - Maintain your Metadata in layers that make sense for your
225 situation. See the ":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`" 225 situation. See the ":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`"
226 section in the Yocto Project Overview and Concepts Manual and the 226 section in the Yocto Project Overview and Concepts Manual and the
227 ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 227 ":ref:`dev-manual/common-tasks:understanding and creating layers`"
228 section for more information on layers. 228 section for more information on layers.
229 229
230 - Separate the project's Metadata and code by using separate Git 230 - Separate the project's Metadata and code by using separate Git
@@ -248,13 +248,13 @@ particular working environment and set of practices.
248 project to fix bugs or add features. If you do submit patches, 248 project to fix bugs or add features. If you do submit patches,
249 follow the project commit guidelines for writing good commit 249 follow the project commit guidelines for writing good commit
250 messages. See the 250 messages. See the
251 ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" 251 ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`"
252 section. 252 section.
253 253
254 - Send changes to the core sooner than later as others are likely 254 - Send changes to the core sooner than later as others are likely
255 to run into the same issues. For some guidance on mailing lists 255 to run into the same issues. For some guidance on mailing lists
256 to use, see the list in the 256 to use, see the list in the
257 ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" 257 ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`"
258 section. For a description 258 section. For a description
259 of the available mailing lists, see the ":ref:`resources-mailinglist`" section in 259 of the available mailing lists, see the ":ref:`resources-mailinglist`" section in
260 the Yocto Project Reference Manual. 260 the Yocto Project Reference Manual.
@@ -340,7 +340,7 @@ Project Build Host:
340Once you have completed the previous steps, you are ready to continue 340Once you have completed the previous steps, you are ready to continue
341using a given development path on your native Linux machine. If you are 341using a given development path on your native Linux machine. If you are
342going to use BitBake, see the 342going to use BitBake, see the
343":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" 343":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`"
344section. If you are going 344section. If you are going
345to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto 345to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
346Project Application Development and the Extensible Software Development 346Project Application Development and the Extensible Software Development
@@ -440,7 +440,7 @@ as your Yocto Project build host:
440Once you have a container set up, everything is in place to develop just 440Once you have a container set up, everything is in place to develop just
441as if you were running on a native Linux machine. If you are going to 441as if you were running on a native Linux machine. If you are going to
442use the Poky container, see the 442use the Poky container, see the
443":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" 443":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`"
444section. If you are going to use the Extensible SDK container, see the 444section. If you are going to use the Extensible SDK container, see the
445":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto 445":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
446Project Application Development and the Extensible Software Development 446Project Application Development and the Extensible Software Development
@@ -582,7 +582,7 @@ files you'll need to work with the Yocto Project.
582Accessing Source Repositories 582Accessing Source Repositories
583----------------------------- 583-----------------------------
584 584
585Working from a copy of the upstream :ref:`dev-manual/dev-manual-start:accessing source repositories` is the 585Working from a copy of the upstream :ref:`dev-manual/start:accessing source repositories` is the
586preferred method for obtaining and using a Yocto Project release. You 586preferred method for obtaining and using a Yocto Project release. You
587can view the Yocto Project Source Repositories at 587can view the Yocto Project Source Repositories at
588:yocto_git:`/`. In particular, you can find the ``poky`` 588:yocto_git:`/`. In particular, you can find the ``poky``
@@ -605,7 +605,7 @@ Use the following procedure to locate the latest upstream copy of the
605 .. note:: 605 .. note::
606 606
607 For information on cloning a repository, see the 607 For information on cloning a repository, see the
608 ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" section. 608 ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" section.
609 609
610Accessing Index of Releases 610Accessing Index of Releases
611--------------------------- 611---------------------------
@@ -801,7 +801,7 @@ and then specifically check out that development branch.
8011. *Switch to the Poky Directory:* If you have a local poky Git 8011. *Switch to the Poky Directory:* If you have a local poky Git
802 repository, switch to that directory. If you do not have the local 802 repository, switch to that directory. If you do not have the local
803 copy of poky, see the 803 copy of poky, see the
804 ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" 804 ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`"
805 section. 805 section.
806 806
8072. *Determine Existing Branch Names:* 8072. *Determine Existing Branch Names:*
@@ -864,7 +864,7 @@ similar to checking out by branch name except you use tag names.
8641. *Switch to the Poky Directory:* If you have a local poky Git 8641. *Switch to the Poky Directory:* If you have a local poky Git
865 repository, switch to that directory. If you do not have the local 865 repository, switch to that directory. If you do not have the local
866 copy of poky, see the 866 copy of poky, see the
867 ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" 867 ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`"
868 section. 868 section.
869 869
8702. *Fetch the Tag Names:* To checkout the branch based on a tag name, 8702. *Fetch the Tag Names:* To checkout the branch based on a tag name,
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst
index 8e9bc27bf5..4bb553f8dd 100644
--- a/documentation/kernel-dev/kernel-dev-common.rst
+++ b/documentation/kernel-dev/kernel-dev-common.rst
@@ -21,11 +21,11 @@ Preparing the Build Host to Work on the Kernel
21 21
22Before you can do any kernel development, you need to be sure your build 22Before you can do any kernel development, you need to be sure your build
23host is set up to use the Yocto Project. For information on how to get 23host is set up to use the Yocto Project. For information on how to get
24set up, see the ":doc:`/dev-manual/dev-manual-start`" section in 24set up, see the ":doc:`/dev-manual/start`" section in
25the Yocto Project Development Tasks Manual. Part of preparing the system 25the Yocto Project Development Tasks Manual. Part of preparing the system
26is creating a local Git repository of the 26is creating a local Git repository of the
27:term:`Source Directory` (``poky``) on your system. Follow the steps in the 27:term:`Source Directory` (``poky``) on your system. Follow the steps in the
28":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" 28":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`"
29section in the Yocto Project Development Tasks Manual to set up your 29section in the Yocto Project Development Tasks Manual to set up your
30Source Directory. 30Source Directory.
31 31
@@ -34,8 +34,8 @@ Source Directory.
34 Be sure you check out the appropriate development branch or you 34 Be sure you check out the appropriate development branch or you
35 create your local branch by checking out a specific tag to get the 35 create your local branch by checking out a specific tag to get the
36 desired version of Yocto Project. See the 36 desired version of Yocto Project. See the
37 ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" and 37 ":ref:`dev-manual/start:checking out by branch in poky`" and
38 ":ref:`dev-manual/dev-manual-start:checking out by tag in poky`" 38 ":ref:`dev-manual/start:checking out by tag in poky`"
39 sections in the Yocto Project Development Tasks Manual for more information. 39 sections in the Yocto Project Development Tasks Manual for more information.
40 40
41Kernel development is best accomplished using 41Kernel development is best accomplished using
@@ -104,13 +104,13 @@ section:
104 104
105 For background information on working with common and BSP layers, 105 For background information on working with common and BSP layers,
106 see the 106 see the
107 ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 107 ":ref:`dev-manual/common-tasks:understanding and creating layers`"
108 section in the Yocto Project Development Tasks Manual and the 108 section in the Yocto Project Development Tasks Manual and the
109 ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board 109 ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board
110 Support (BSP) Developer's Guide, respectively. For information on how to 110 Support (BSP) Developer's Guide, respectively. For information on how to
111 use the ``bitbake-layers create-layer`` command to quickly set up a layer, 111 use the ``bitbake-layers create-layer`` command to quickly set up a layer,
112 see the 112 see the
113 ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" 113 ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`"
114 section in the Yocto Project Development Tasks Manual. 114 section in the Yocto Project Development Tasks Manual.
115 115
1164. *Inform the BitBake Build Environment About Your Layer:* As directed 1164. *Inform the BitBake Build Environment About Your Layer:* As directed
@@ -236,7 +236,7 @@ section:
236 Also, for this example, be sure that the local branch you have 236 Also, for this example, be sure that the local branch you have
237 checked out for ``poky`` is the Yocto Project &DISTRO_NAME; branch. If 237 checked out for ``poky`` is the Yocto Project &DISTRO_NAME; branch. If
238 you need to checkout out the &DISTRO_NAME; branch, see the 238 you need to checkout out the &DISTRO_NAME; branch, see the
239 ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" 239 ":ref:`dev-manual/start:checking out by branch in poky`"
240 section in the Yocto Project Development Tasks Manual. 240 section in the Yocto Project Development Tasks Manual.
241 :: 241 ::
242 242
@@ -289,13 +289,13 @@ section:
289 289
290 For background information on working with common and BSP layers, 290 For background information on working with common and BSP layers,
291 see the 291 see the
292 ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 292 ":ref:`dev-manual/common-tasks:understanding and creating layers`"
293 section in the Yocto Project Development Tasks Manual and the 293 section in the Yocto Project Development Tasks Manual and the
294 ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board 294 ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto Project Board
295 Support (BSP) Developer's Guide, respectively. For information on how to 295 Support (BSP) Developer's Guide, respectively. For information on how to
296 use the ``bitbake-layers create-layer`` command to quickly set up a layer, 296 use the ``bitbake-layers create-layer`` command to quickly set up a layer,
297 see the 297 see the
298 ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" 298 ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`"
299 section in the Yocto Project Development Tasks Manual. 299 section in the Yocto Project Development Tasks Manual.
300 300
3014. *Inform the BitBake Build Environment About Your Layer:* As directed 3014. *Inform the BitBake Build Environment About Your Layer:* As directed
@@ -378,7 +378,7 @@ layer contains its own :term:`BitBake`
378append files (``.bbappend``) and provides a convenient mechanism to 378append files (``.bbappend``) and provides a convenient mechanism to
379create your own recipe files (``.bb``) as well as store and use kernel 379create your own recipe files (``.bb``) as well as store and use kernel
380patch files. For background information on working with layers, see the 380patch files. For background information on working with layers, see the
381":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 381":ref:`dev-manual/common-tasks:understanding and creating layers`"
382section in the Yocto Project Development Tasks Manual. 382section in the Yocto Project Development Tasks Manual.
383 383
384.. note:: 384.. note::
@@ -386,7 +386,7 @@ section in the Yocto Project Development Tasks Manual.
386 The Yocto Project comes with many tools that simplify tasks you need 386 The Yocto Project comes with many tools that simplify tasks you need
387 to perform. One such tool is the ``bitbake-layers create-layer`` 387 to perform. One such tool is the ``bitbake-layers create-layer``
388 command, which simplifies creating a new layer. See the 388 command, which simplifies creating a new layer. See the
389 ":ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" 389 ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`"
390 section in the Yocto Project Development Tasks Manual for 390 section in the Yocto Project Development Tasks Manual for
391 information on how to use this script to quick set up a new layer. 391 information on how to use this script to quick set up a new layer.
392 392
@@ -443,7 +443,7 @@ home directory:
443 The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements 443 The :term:`FILESEXTRAPATHS` and :term:`SRC_URI` statements
444 enable the OpenEmbedded build system to find patch files. For more 444 enable the OpenEmbedded build system to find patch files. For more
445 information on using append files, see the 445 information on using append files, see the
446 ":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" 446 ":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
447 section in the Yocto Project Development Tasks Manual. 447 section in the Yocto Project Development Tasks Manual.
448 448
449Modifying an Existing Recipe 449Modifying an Existing Recipe
@@ -1108,7 +1108,7 @@ Section.
1108 For more information on append files and patches, see the "`Creating 1108 For more information on append files and patches, see the "`Creating
1109 the Append File <#creating-the-append-file>`__" and "`Applying 1109 the Append File <#creating-the-append-file>`__" and "`Applying
1110 Patches <#applying-patches>`__" sections. You can also see the 1110 Patches <#applying-patches>`__" sections. You can also see the
1111 ":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" 1111 ":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
1112 section in the Yocto Project Development Tasks Manual. 1112 section in the Yocto Project Development Tasks Manual.
1113 1113
1114 .. note:: 1114 .. note::
diff --git a/documentation/kernel-dev/kernel-dev-faq.rst b/documentation/kernel-dev/kernel-dev-faq.rst
index 424e626170..54623453a4 100644
--- a/documentation/kernel-dev/kernel-dev-faq.rst
+++ b/documentation/kernel-dev/kernel-dev-faq.rst
@@ -38,7 +38,7 @@ The kernel image (e.g. ``vmlinuz``) is provided by the
38specify whether or not the kernel image is installed in the generated 38specify whether or not the kernel image is installed in the generated
39root filesystem, override ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base`` to include or not 39root filesystem, override ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base`` to include or not
40include "kernel-image". See the 40include "kernel-image". See the
41":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" 41":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
42section in the 42section in the
43Yocto Project Development Tasks Manual for information on how to use an 43Yocto Project Development Tasks Manual for information on how to use an
44append file to override metadata. 44append file to override metadata.
diff --git a/documentation/kernel-dev/kernel-dev-intro.rst b/documentation/kernel-dev/kernel-dev-intro.rst
index 29d4516c53..3987b0e59d 100644
--- a/documentation/kernel-dev/kernel-dev-intro.rst
+++ b/documentation/kernel-dev/kernel-dev-intro.rst
@@ -88,7 +88,7 @@ understand the following documentation:
88 as described in the Yocto Project Application Development and the 88 as described in the Yocto Project Application Development and the
89 Extensible Software Development Kit (eSDK) manual. 89 Extensible Software Development Kit (eSDK) manual.
90 90
91- The ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 91- The ":ref:`dev-manual/common-tasks:understanding and creating layers`"
92 section in the Yocto Project Development Tasks Manual. 92 section in the Yocto Project Development Tasks Manual.
93 93
94- The "`Kernel Modification 94- The "`Kernel Modification
@@ -111,7 +111,7 @@ general information and references for further information.
111 :align: center 111 :align: center
112 112
1131. *Set up Your Host Development System to Support Development Using the 1131. *Set up Your Host Development System to Support Development Using the
114 Yocto Project*: See the ":doc:`/dev-manual/dev-manual-start`" section in 114 Yocto Project*: See the ":doc:`/dev-manual/start`" section in
115 the Yocto Project Development Tasks Manual for options on how to get 115 the Yocto Project Development Tasks Manual for options on how to get
116 a build host ready to use the Yocto Project. 116 a build host ready to use the Yocto Project.
117 117
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst
index bbf2d0494e..d2e335e802 100644
--- a/documentation/overview-manual/overview-manual-concepts.rst
+++ b/documentation/overview-manual/overview-manual-concepts.rst
@@ -34,7 +34,7 @@ itself is of various types:
34 34
35BitBake knows how to combine multiple data sources together and refers 35BitBake knows how to combine multiple data sources together and refers
36to each data source as a layer. For information on layers, see the 36to each data source as a layer. For information on layers, see the
37":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 37":ref:`dev-manual/common-tasks:understanding and creating layers`"
38section of the Yocto Project Development Tasks Manual. 38section of the Yocto Project Development Tasks Manual.
39 39
40Following are some brief details on these core components. For 40Following are some brief details on these core components. For
@@ -153,7 +153,7 @@ Conforming to a known structure allows BitBake to make assumptions
153during builds on where to find types of metadata. You can find 153during builds on where to find types of metadata. You can find
154procedures and learn about tools (i.e. ``bitbake-layers``) for creating 154procedures and learn about tools (i.e. ``bitbake-layers``) for creating
155layers suitable for the Yocto Project in the 155layers suitable for the Yocto Project in the
156":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 156":ref:`dev-manual/common-tasks:understanding and creating layers`"
157section of the Yocto Project Development Tasks Manual. 157section of the Yocto Project Development Tasks Manual.
158 158
159OpenEmbedded Build System Concepts 159OpenEmbedded Build System Concepts
@@ -317,7 +317,7 @@ during the build. By default, the layers listed in this file include
317layers minimally needed by the build system. However, you must manually 317layers minimally needed by the build system. However, you must manually
318add any custom layers you have created. You can find more information on 318add any custom layers you have created. You can find more information on
319working with the ``bblayers.conf`` file in the 319working with the ``bblayers.conf`` file in the
320":ref:`dev-manual/dev-manual-common-tasks:enabling your layer`" 320":ref:`dev-manual/common-tasks:enabling your layer`"
321section in the Yocto Project Development Tasks Manual. 321section in the Yocto Project Development Tasks Manual.
322 322
323The files ``site.conf`` and ``auto.conf`` are not created by the 323The files ``site.conf`` and ``auto.conf`` are not created by the
@@ -418,7 +418,7 @@ a ``README`` file as good practice and especially if the layer is to be
418distributed, a configuration directory, and recipe directories. You can 418distributed, a configuration directory, and recipe directories. You can
419learn about the general structure for layers used with the Yocto Project 419learn about the general structure for layers used with the Yocto Project
420in the 420in the
421":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" 421":ref:`dev-manual/common-tasks:creating your own layer`"
422section in the 422section in the
423Yocto Project Development Tasks Manual. For a general discussion on 423Yocto Project Development Tasks Manual. For a general discussion on
424layers and the many layers from which you can draw, see the 424layers and the many layers from which you can draw, see the
@@ -827,7 +827,7 @@ For more information on how the source directories are created, see the
827"`Source Fetching <#source-fetching-dev-environment>`__" section. For 827"`Source Fetching <#source-fetching-dev-environment>`__" section. For
828more information on how to create patches and how the build system 828more information on how to create patches and how the build system
829processes patches, see the 829processes patches, see the
830":ref:`dev-manual/dev-manual-common-tasks:patching code`" 830":ref:`dev-manual/common-tasks:patching code`"
831section in the 831section in the
832Yocto Project Development Tasks Manual. You can also see the 832Yocto Project Development Tasks Manual. You can also see the
833":ref:`sdk-manual/sdk-extensible:use \`\`devtool modify\`\` to modify the source of an existing component`" 833":ref:`sdk-manual/sdk-extensible:use \`\`devtool modify\`\` to modify the source of an existing component`"
@@ -1029,7 +1029,7 @@ stage of package installation, post installation scripts that are part
1029of the packages are run. Any scripts that fail to run on the build host 1029of the packages are run. Any scripts that fail to run on the build host
1030are run on the target when the target system is first booted. If you are 1030are run on the target when the target system is first booted. If you are
1031using a 1031using a
1032:ref:`read-only root filesystem <dev-manual/dev-manual-common-tasks:creating a read-only root filesystem>`, 1032:ref:`read-only root filesystem <dev-manual/common-tasks:creating a read-only root filesystem>`,
1033all the post installation scripts must succeed on the build host during 1033all the post installation scripts must succeed on the build host during
1034the package installation phase since the root filesystem on the target 1034the package installation phase since the root filesystem on the target
1035is read-only. 1035is read-only.
@@ -1192,7 +1192,7 @@ varflag. If some other task depends on such a task, then that task will
1192also always be considered out of date, which might not be what you want. 1192also always be considered out of date, which might not be what you want.
1193 1193
1194For details on how to view information about a task's signature, see the 1194For details on how to view information about a task's signature, see the
1195":ref:`dev-manual/dev-manual-common-tasks:viewing task variable dependencies`" 1195":ref:`dev-manual/common-tasks:viewing task variable dependencies`"
1196section in the Yocto Project Development Tasks Manual. 1196section in the Yocto Project Development Tasks Manual.
1197 1197
1198Setscene Tasks and Shared State 1198Setscene Tasks and Shared State
@@ -1626,15 +1626,15 @@ them if they are deemed to be valid.
1626 the shared state packages. Consequently, considerations exist that 1626 the shared state packages. Consequently, considerations exist that
1627 affect maintaining shared state feeds. For information on how the 1627 affect maintaining shared state feeds. For information on how the
1628 build system works with packages and can track incrementing ``PR`` 1628 build system works with packages and can track incrementing ``PR``
1629 information, see the ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" 1629 information, see the ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`"
1630 section in the Yocto Project Development Tasks Manual. 1630 section in the Yocto Project Development Tasks Manual.
1631 1631
1632 - The code in the build system that supports incremental builds is 1632 - The code in the build system that supports incremental builds is
1633 not simple code. For techniques that help you work around issues 1633 not simple code. For techniques that help you work around issues
1634 related to shared state code, see the 1634 related to shared state code, see the
1635 ":ref:`dev-manual/dev-manual-common-tasks:viewing metadata used to create the input signature of a shared state task`" 1635 ":ref:`dev-manual/common-tasks:viewing metadata used to create the input signature of a shared state task`"
1636 and 1636 and
1637 ":ref:`dev-manual/dev-manual-common-tasks:invalidating shared state to force a task to run`" 1637 ":ref:`dev-manual/common-tasks:invalidating shared state to force a task to run`"
1638 sections both in the Yocto Project Development Tasks Manual. 1638 sections both in the Yocto Project Development Tasks Manual.
1639 1639
1640The rest of this section goes into detail about the overall incremental 1640The rest of this section goes into detail about the overall incremental
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst
index 2421ec1a85..e03b4cdc62 100644
--- a/documentation/overview-manual/overview-manual-development-environment.rst
+++ b/documentation/overview-manual/overview-manual-development-environment.rst
@@ -66,7 +66,7 @@ to set up a CROPS machine, you effectively have access to a shell
66environment that is similar to what you see when using a Linux-based 66environment that is similar to what you see when using a Linux-based
67development host. For the steps needed to set up a system using CROPS, 67development host. For the steps needed to set up a system using CROPS,
68see the 68see the
69":ref:`dev-manual/dev-manual-start:setting up to use cross platforms (crops)`" 69":ref:`dev-manual/start:setting up to use cross platforms (crops)`"
70section in 70section in
71the Yocto Project Development Tasks Manual. 71the Yocto Project Development Tasks Manual.
72 72
@@ -77,7 +77,7 @@ distribution on the system is one that supports the Yocto Project. You
77also need to be sure that the correct set of host packages are installed 77also need to be sure that the correct set of host packages are installed
78that allow development using the Yocto Project. For the steps needed to 78that allow development using the Yocto Project. For the steps needed to
79set up a development host that runs Linux, see the 79set up a development host that runs Linux, see the
80":ref:`dev-manual/dev-manual-start:setting up a native linux host`" 80":ref:`dev-manual/start:setting up a native linux host`"
81section in the Yocto Project Development Tasks Manual. 81section in the Yocto Project Development Tasks Manual.
82 82
83Once your development host is set up to use the Yocto Project, several 83Once your development host is set up to use the Yocto Project, several
@@ -94,7 +94,7 @@ methods exist for you to do work in the Yocto Project environment:
94 through your Linux distribution and the Yocto Project. 94 through your Linux distribution and the Yocto Project.
95 95
96 For a general flow of the build procedures, see the 96 For a general flow of the build procedures, see the
97 ":ref:`dev-manual/dev-manual-common-tasks:building a simple image`" 97 ":ref:`dev-manual/common-tasks:building a simple image`"
98 section in the Yocto Project Development Tasks Manual. 98 section in the Yocto Project Development Tasks Manual.
99 99
100- *Board Support Package (BSP) Development:* Development of BSPs 100- *Board Support Package (BSP) Development:* Development of BSPs
@@ -178,7 +178,7 @@ development:
178 :align: center 178 :align: center
179 179
180 For steps on how to view and access these upstream Git repositories, 180 For steps on how to view and access these upstream Git repositories,
181 see the ":ref:`dev-manual/dev-manual-start:accessing source repositories`" 181 see the ":ref:`dev-manual/start:accessing source repositories`"
182 Section in the Yocto Project Development Tasks Manual. 182 Section in the Yocto Project Development Tasks Manual.
183 183
184- :yocto_dl:`Index of /releases: </releases>` This is an index 184- :yocto_dl:`Index of /releases: </releases>` This is an index
@@ -192,7 +192,7 @@ development:
192 :align: center 192 :align: center
193 193
194 For steps on how to view and access these files, see the 194 For steps on how to view and access these files, see the
195 ":ref:`dev-manual/dev-manual-start:accessing index of releases`" 195 ":ref:`dev-manual/start:accessing index of releases`"
196 section in the Yocto Project Development Tasks Manual. 196 section in the Yocto Project Development Tasks Manual.
197 197
198- *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:* 198- *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:*
@@ -207,7 +207,7 @@ development:
207 :align: center 207 :align: center
208 208
209 For steps on how to use the "DOWNLOADS" page, see the 209 For steps on how to use the "DOWNLOADS" page, see the
210 ":ref:`dev-manual/dev-manual-start:using the downloads page`" 210 ":ref:`dev-manual/start:using the downloads page`"
211 section in the Yocto Project Development Tasks Manual. 211 section in the Yocto Project Development Tasks Manual.
212 212
213Git Workflows and the Yocto Project 213Git Workflows and the Yocto Project
@@ -242,7 +242,7 @@ and so forth.
242 242
243 For information on finding out who is responsible for (maintains) a 243 For information on finding out who is responsible for (maintains) a
244 particular area of code in the Yocto Project, see the 244 particular area of code in the Yocto Project, see the
245 ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" 245 ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`"
246 section of the Yocto Project Development Tasks Manual. 246 section of the Yocto Project Development Tasks Manual.
247 247
248The Yocto Project ``poky`` Git repository also has an upstream 248The Yocto Project ``poky`` Git repository also has an upstream
@@ -274,7 +274,7 @@ push them into the "contrib" area and subsequently request that the
274maintainer include them into an upstream branch. This process is called 274maintainer include them into an upstream branch. This process is called
275"submitting a patch" or "submitting a change." For information on 275"submitting a patch" or "submitting a change." For information on
276submitting patches and changes, see the 276submitting patches and changes, see the
277":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" 277":ref:`dev-manual/common-tasks:submitting a change to the yocto project`"
278section in the Yocto Project Development Tasks Manual. 278section in the Yocto Project Development Tasks Manual.
279 279
280In summary, a single point of entry exists for changes into a "master" 280In summary, a single point of entry exists for changes into a "master"
@@ -341,7 +341,7 @@ Book <http://book.git-scm.com>`__.
341 the ``scripts`` folder of the 341 the ``scripts`` folder of the
342 :term:`Source Directory`. For information 342 :term:`Source Directory`. For information
343 on how to use these scripts, see the 343 on how to use these scripts, see the
344 ":ref:`dev-manual/dev-manual-common-tasks:using scripts to push a change upstream and request a pull`" 344 ":ref:`dev-manual/common-tasks:using scripts to push a change upstream and request a pull`"
345 section in the Yocto Project Development Tasks Manual. 345 section in the Yocto Project Development Tasks Manual.
346 346
347- *Patch Workflow:* This workflow allows you to notify the maintainer 347- *Patch Workflow:* This workflow allows you to notify the maintainer
@@ -350,7 +350,7 @@ Book <http://book.git-scm.com>`__.
350 this type of change, you format the patch and then send the email 350 this type of change, you format the patch and then send the email
351 using the Git commands ``git format-patch`` and ``git send-email``. 351 using the Git commands ``git format-patch`` and ``git send-email``.
352 For information on how to use these scripts, see the 352 For information on how to use these scripts, see the
353 ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" 353 ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`"
354 section in the Yocto Project Development Tasks Manual. 354 section in the Yocto Project Development Tasks Manual.
355 355
356Git 356Git
@@ -376,7 +376,7 @@ commands.
376 page, see http://git-scm.com/download. 376 page, see http://git-scm.com/download.
377 377
378 - For information beyond the introductory nature in this section, 378 - For information beyond the introductory nature in this section,
379 see the ":ref:`dev-manual/dev-manual-start:locating yocto project source files`" 379 see the ":ref:`dev-manual/start:locating yocto project source files`"
380 section in the Yocto Project Development Tasks Manual. 380 section in the Yocto Project Development Tasks Manual.
381 381
382Repositories, Tags, and Branches 382Repositories, Tags, and Branches
@@ -408,7 +408,7 @@ You can create a local copy of any repository by "cloning" it with the
408an identical copy of the repository on your development system. Once you 408an identical copy of the repository on your development system. Once you
409have a local copy of a repository, you can take steps to develop 409have a local copy of a repository, you can take steps to develop
410locally. For examples on how to clone Git repositories, see the 410locally. For examples on how to clone Git repositories, see the
411":ref:`dev-manual/dev-manual-start:locating yocto project source files`" 411":ref:`dev-manual/start:locating yocto project source files`"
412section in the Yocto Project Development Tasks Manual. 412section in the Yocto Project Development Tasks Manual.
413 413
414It is important to understand that Git tracks content change and not 414It is important to understand that Git tracks content change and not
@@ -661,5 +661,5 @@ Project uses in the ``meta/files/common-licenses`` directory in your
661For information that can help you maintain compliance with various open 661For information that can help you maintain compliance with various open
662source licensing during the lifecycle of a product created using the 662source licensing during the lifecycle of a product created using the
663Yocto Project, see the 663Yocto Project, see the
664":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" 664":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
665section in the Yocto Project Development Tasks Manual. 665section in the Yocto Project Development Tasks Manual.
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index d6488c6211..a6568d1c8e 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -130,7 +130,7 @@ Project:
130 arbitrarily include packages. 130 arbitrarily include packages.
131 131
132- *License Manifest:* The Yocto Project provides a :ref:`license 132- *License Manifest:* The Yocto Project provides a :ref:`license
133 manifest <dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle>` 133 manifest <dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle>`
134 for review by people who need to track the use of open source 134 for review by people who need to track the use of open source
135 licenses (e.g. legal teams). 135 licenses (e.g. legal teams).
136 136
@@ -228,7 +228,7 @@ your Metadata, the easier it is to cope with future changes.
228 228
229 - Layers support the inclusion of technologies, hardware components, 229 - Layers support the inclusion of technologies, hardware components,
230 and software components. The :ref:`Yocto Project 230 and software components. The :ref:`Yocto Project
231 Compatible <dev-manual/dev-manual-common-tasks:making sure your layer is compatible with yocto project>` 231 Compatible <dev-manual/common-tasks:making sure your layer is compatible with yocto project>`
232 designation provides a minimum level of standardization that 232 designation provides a minimum level of standardization that
233 contributes to a strong ecosystem. "YP Compatible" is applied to 233 contributes to a strong ecosystem. "YP Compatible" is applied to
234 appropriate products and software components such as BSPs, other 234 appropriate products and software components such as BSPs, other
@@ -274,7 +274,7 @@ of the ``poky`` repository, you will see several layers: ``meta``,
274layer. 274layer.
275 275
276For procedures on how to create layers, see the 276For procedures on how to create layers, see the
277":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 277":ref:`dev-manual/common-tasks:understanding and creating layers`"
278section in the Yocto Project Development Tasks Manual. 278section in the Yocto Project Development Tasks Manual.
279 279
280Components and Tools 280Components and Tools
@@ -357,7 +357,7 @@ activities using the Yocto Project:
357 (BitBake and 357 (BitBake and
358 OE-Core) automatically generates upgrades for recipes that are based 358 OE-Core) automatically generates upgrades for recipes that are based
359 on new versions of the recipes published upstream. See 359 on new versions of the recipes published upstream. See
360 :ref:`dev-manual/dev-manual-common-tasks:using the auto upgrade helper (auh)` 360 :ref:`dev-manual/common-tasks:using the auto upgrade helper (auh)`
361 for how to set it up. 361 for how to set it up.
362 362
363- *Recipe Reporting System:* The Recipe Reporting System tracks recipe 363- *Recipe Reporting System:* The Recipe Reporting System tracks recipe
@@ -601,7 +601,7 @@ Project.
601 601
602 For information on how to set up a Build Host on a system running 602 For information on how to set up a Build Host on a system running
603 Linux as its native operating system, see the 603 Linux as its native operating system, see the
604 ":ref:`dev-manual/dev-manual-start:setting up a native linux host`" 604 ":ref:`dev-manual/start:setting up a native linux host`"
605 section in the Yocto Project Development Tasks Manual. 605 section in the Yocto Project Development Tasks Manual.
606 606
607- *CROss PlatformS (CROPS):* Typically, you use 607- *CROss PlatformS (CROPS):* Typically, you use
@@ -621,7 +621,7 @@ Project.
621 system natively running Linux. 621 system natively running Linux.
622 622
623 For information on how to set up a Build Host with CROPS, see the 623 For information on how to set up a Build Host with CROPS, see the
624 ":ref:`dev-manual/dev-manual-start:setting up to use cross platforms (crops)`" 624 ":ref:`dev-manual/start:setting up to use cross platforms (crops)`"
625 section in the Yocto Project Development Tasks Manual. 625 section in the Yocto Project Development Tasks Manual.
626 626
627- *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem 627- *Windows Subsystem For Linux (WSLv2):* You may use Windows Subsystem
@@ -638,7 +638,7 @@ Project.
638 virtualization technology. 638 virtualization technology.
639 639
640 For information on how to set up a Build Host with WSLv2, see the 640 For information on how to set up a Build Host with WSLv2, see the
641 ":ref:`dev-manual/dev-manual-start:setting up to use windows subsystem for linux (wslv2)`" 641 ":ref:`dev-manual/start:setting up to use windows subsystem for linux (wslv2)`"
642 section in the Yocto Project Development Tasks Manual. 642 section in the Yocto Project Development Tasks Manual.
643 643
644- *Toaster:* Regardless of what your Build Host is running, you can use 644- *Toaster:* Regardless of what your Build Host is running, you can use
@@ -824,7 +824,7 @@ helpful for getting started:
824 Project. 824 Project.
825 825
826 For more detailed information on layers, see the 826 For more detailed information on layers, see the
827 ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 827 ":ref:`dev-manual/common-tasks:understanding and creating layers`"
828 section in the Yocto Project Development Tasks Manual. For a 828 section in the Yocto Project Development Tasks Manual. For a
829 discussion specifically on BSP Layers, see the 829 discussion specifically on BSP Layers, see the
830 ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto 830 ":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 819b6857d9..5b9fcc1912 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -45,7 +45,7 @@ section for steps on how to update your build tools.
45**A:** Support for an additional board is added by creating a Board 45**A:** Support for an additional board is added by creating a Board
46Support Package (BSP) layer for it. For more information on how to 46Support Package (BSP) layer for it. For more information on how to
47create a BSP layer, see the 47create a BSP layer, see the
48":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 48":ref:`dev-manual/common-tasks:understanding and creating layers`"
49section in the Yocto Project Development Tasks Manual and the 49section in the Yocto Project Development Tasks Manual and the
50:doc:`/bsp-guide/index`. 50:doc:`/bsp-guide/index`.
51 51
@@ -73,7 +73,7 @@ device.
73 73
74**A:** To add a package, you need to create a BitBake recipe. For 74**A:** To add a package, you need to create a BitBake recipe. For
75information on how to create a BitBake recipe, see the 75information on how to create a BitBake recipe, see the
76":ref:`dev-manual/dev-manual-common-tasks:writing a new recipe`" 76":ref:`dev-manual/common-tasks:writing a new recipe`"
77section in the Yocto Project Development Tasks Manual. 77section in the Yocto Project Development Tasks Manual.
78 78
79**Q:** Do I have to reflash my entire board with a new Yocto Project 79**Q:** Do I have to reflash my entire board with a new Yocto Project
@@ -201,7 +201,7 @@ You can find more information on licensing in the
201":ref:`overview-manual/overview-manual-development-environment:licensing`" 201":ref:`overview-manual/overview-manual-development-environment:licensing`"
202section in the Yocto 202section in the Yocto
203Project Overview and Concepts Manual and also in the 203Project Overview and Concepts Manual and also in the
204":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" 204":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
205section in the Yocto Project Development Tasks Manual. 205section in the Yocto Project Development Tasks Manual.
206 206
207**Q:** How do I disable the cursor on my touchscreen device? 207**Q:** How do I disable the cursor on my touchscreen device?
diff --git a/documentation/ref-manual/migration-1.4.rst b/documentation/ref-manual/migration-1.4.rst
index daaea0ffa2..0b7e861176 100644
--- a/documentation/ref-manual/migration-1.4.rst
+++ b/documentation/ref-manual/migration-1.4.rst
@@ -84,7 +84,7 @@ create an append file for the ``init-ifupdown`` recipe instead, which
84you can find in the :term:`Source Directory` at 84you can find in the :term:`Source Directory` at
85``meta/recipes-core/init-ifupdown``. For information on how to use 85``meta/recipes-core/init-ifupdown``. For information on how to use
86append files, see the 86append files, see the
87":ref:`dev-manual/dev-manual-common-tasks:using .bbappend files in your layer`" 87":ref:`dev-manual/common-tasks:using .bbappend files in your layer`"
88section in the Yocto Project Development Tasks Manual. 88section in the Yocto Project Development Tasks Manual.
89 89
90.. _migration-1.4-remote-debugging: 90.. _migration-1.4-remote-debugging:
diff --git a/documentation/ref-manual/migration-1.5.rst b/documentation/ref-manual/migration-1.5.rst
index 5e1e23f216..b5e4bb1fd1 100644
--- a/documentation/ref-manual/migration-1.5.rst
+++ b/documentation/ref-manual/migration-1.5.rst
@@ -246,7 +246,7 @@ A new automated image testing framework has been added through the
246framework replaces the older ``imagetest-qemu`` framework. 246framework replaces the older ``imagetest-qemu`` framework.
247 247
248You can learn more about performing automated image tests in the 248You can learn more about performing automated image tests in the
249":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 249":ref:`dev-manual/common-tasks:performing automated runtime testing`"
250section in the Yocto Project Development Tasks Manual. 250section in the Yocto Project Development Tasks Manual.
251 251
252.. _migration-1.5-build-history: 252.. _migration-1.5-build-history:
@@ -269,7 +269,7 @@ Following are changes to Build History:
269 option for each utility for more information on the new syntax. 269 option for each utility for more information on the new syntax.
270 270
271For more information on Build History, see the 271For more information on Build History, see the
272":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" 272":ref:`dev-manual/common-tasks:maintaining build output quality`"
273section in the Yocto Project Development Tasks Manual. 273section in the Yocto Project Development Tasks Manual.
274 274
275.. _migration-1.5-udev: 275.. _migration-1.5-udev:
diff --git a/documentation/ref-manual/migration-1.6.rst b/documentation/ref-manual/migration-1.6.rst
index 822d5cfa03..f95f45ec9f 100644
--- a/documentation/ref-manual/migration-1.6.rst
+++ b/documentation/ref-manual/migration-1.6.rst
@@ -12,7 +12,7 @@ Project 1.6 Release from the prior release.
12The :ref:`archiver <ref-classes-archiver>` class has been rewritten 12The :ref:`archiver <ref-classes-archiver>` class has been rewritten
13and its configuration has been simplified. For more details on the 13and its configuration has been simplified. For more details on the
14source archiver, see the 14source archiver, see the
15":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" 15":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
16section in the Yocto Project Development Tasks Manual. 16section in the Yocto Project Development Tasks Manual.
17 17
18.. _migration-1.6-packaging-changes: 18.. _migration-1.6-packaging-changes:
@@ -148,7 +148,7 @@ NFS mount, an error occurs.
148The ``PRINC`` variable has been deprecated and triggers a warning if 148The ``PRINC`` variable has been deprecated and triggers a warning if
149detected during a build. For :term:`PR` increments on changes, 149detected during a build. For :term:`PR` increments on changes,
150use the PR service instead. You can find out more about this service in 150use the PR service instead. You can find out more about this service in
151the ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" 151the ":ref:`dev-manual/common-tasks:working with a pr service`"
152section in the Yocto Project Development Tasks Manual. 152section in the Yocto Project Development Tasks Manual.
153 153
154.. _migration-1.6-variable-changes-IMAGE_TYPES: 154.. _migration-1.6-variable-changes-IMAGE_TYPES:
@@ -221,7 +221,7 @@ Package Test (ptest)
221 221
222Package Tests (ptest) are built but not installed by default. For 222Package Tests (ptest) are built but not installed by default. For
223information on using Package Tests, see the 223information on using Package Tests, see the
224":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" 224":ref:`dev-manual/common-tasks:testing packages with ptest`"
225section in the Yocto Project Development Tasks Manual. For information on the 225section in the Yocto Project Development Tasks Manual. For information on the
226``ptest`` class, see the ":ref:`ptest.bbclass <ref-classes-ptest>`" 226``ptest`` class, see the ":ref:`ptest.bbclass <ref-classes-ptest>`"
227section. 227section.
diff --git a/documentation/ref-manual/migration-1.7.rst b/documentation/ref-manual/migration-1.7.rst
index c3f9469da1..85894d9df7 100644
--- a/documentation/ref-manual/migration-1.7.rst
+++ b/documentation/ref-manual/migration-1.7.rst
@@ -217,7 +217,7 @@ The following miscellaneous change occurred:
217 should manually remove old "build-id" files from your existing build 217 should manually remove old "build-id" files from your existing build
218 history repositories to avoid confusion. For information on the build 218 history repositories to avoid confusion. For information on the build
219 history feature, see the 219 history feature, see the
220 ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" 220 ":ref:`dev-manual/common-tasks:maintaining build output quality`"
221 section in the Yocto Project Development Tasks Manual. 221 section in the Yocto Project Development Tasks Manual.
222 222
223 223
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst
index ada9d2986c..678a767e15 100644
--- a/documentation/ref-manual/migration-2.1.rst
+++ b/documentation/ref-manual/migration-2.1.rst
@@ -346,7 +346,7 @@ This release supports generation of GLib Introspective Repository (GIR)
346files through GObject introspection, which is the standard mechanism for 346files through GObject introspection, which is the standard mechanism for
347accessing GObject-based software from runtime environments. You can 347accessing GObject-based software from runtime environments. You can
348enable, disable, and test the generation of this data. See the 348enable, disable, and test the generation of this data. See the
349":ref:`dev-manual/dev-manual-common-tasks:enabling gobject introspection support`" 349":ref:`dev-manual/common-tasks:enabling gobject introspection support`"
350section in the Yocto Project Development Tasks Manual for more 350section in the Yocto Project Development Tasks Manual for more
351information. 351information.
352 352
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst
index c0a8f04195..9e95f45e1f 100644
--- a/documentation/ref-manual/migration-2.3.rst
+++ b/documentation/ref-manual/migration-2.3.rst
@@ -366,7 +366,7 @@ The following changes have been made to Wic:
366.. note:: 366.. note::
367 367
368 For more information on Wic, see the 368 For more information on Wic, see the
369 ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" 369 ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
370 section in the Yocto Project Development Tasks Manual. 370 section in the Yocto Project Development Tasks Manual.
371 371
372- *Default Output Directory Changed:* Wic's default output directory is 372- *Default Output Directory Changed:* Wic's default output directory is
diff --git a/documentation/ref-manual/migration-2.5.rst b/documentation/ref-manual/migration-2.5.rst
index 7f1b80938f..9f45ffce76 100644
--- a/documentation/ref-manual/migration-2.5.rst
+++ b/documentation/ref-manual/migration-2.5.rst
@@ -266,7 +266,7 @@ The following are additional changes:
266 will trigger a warning during ``do_rootfs``. 266 will trigger a warning during ``do_rootfs``.
267 267
268 For more information, see the 268 For more information, see the
269 ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" 269 ":ref:`dev-manual/common-tasks:post-installation scripts`"
270 section in the Yocto Project Development Tasks Manual. 270 section in the Yocto Project Development Tasks Manual.
271 271
272- The ``elf`` image type has been removed. This image type was removed 272- The ``elf`` image type has been removed. This image type was removed
diff --git a/documentation/ref-manual/migration-2.6.rst b/documentation/ref-manual/migration-2.6.rst
index cc7c24c5b1..5d524f3817 100644
--- a/documentation/ref-manual/migration-2.6.rst
+++ b/documentation/ref-manual/migration-2.6.rst
@@ -372,7 +372,7 @@ Any failure of a ``pkg_postinst()`` script (including exit 1) triggers
372an error during the :ref:`ref-tasks-rootfs` task. 372an error during the :ref:`ref-tasks-rootfs` task.
373 373
374For more information on post-installation behavior, see the 374For more information on post-installation behavior, see the
375":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" 375":ref:`dev-manual/common-tasks:post-installation scripts`"
376section in the Yocto Project Development Tasks Manual. 376section in the Yocto Project Development Tasks Manual.
377 377
378.. _migration-2.6-python-3-profile-guided-optimizations: 378.. _migration-2.6-python-3-profile-guided-optimizations:
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index e0cdbe87fa..4147044ea3 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -68,7 +68,7 @@ The ``archiver`` class supports releasing source code and other
68materials with the binaries. 68materials with the binaries.
69 69
70For more details on the source archiver, see the 70For more details on the source archiver, see the
71":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" 71":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
72section in the Yocto Project Development Tasks Manual. You can also see 72section in the Yocto Project Development Tasks Manual. You can also see
73the :term:`ARCHIVER_MODE` variable for information 73the :term:`ARCHIVER_MODE` variable for information
74about the variable flags (varflags) that help control archive creation. 74about the variable flags (varflags) that help control archive creation.
@@ -86,7 +86,7 @@ standardization. This class defines a set of tasks (e.g. ``configure``,
86should usually be enough to define a few standard variables and then 86should usually be enough to define a few standard variables and then
87simply ``inherit autotools``. These classes can also work with software 87simply ``inherit autotools``. These classes can also work with software
88that emulates Autotools. For more information, see the 88that emulates Autotools. For more information, see the
89":ref:`dev-manual/dev-manual-common-tasks:autotooled package`" section 89":ref:`dev-manual/common-tasks:autotooled package`" section
90in the Yocto Project Development Tasks Manual. 90in the Yocto Project Development Tasks Manual.
91 91
92By default, the ``autotools*`` classes use out-of-tree builds (i.e. 92By default, the ``autotools*`` classes use out-of-tree builds (i.e.
@@ -236,7 +236,7 @@ The ``buildhistory`` class records a history of build output metadata,
236which can be used to detect possible regressions as well as used for 236which can be used to detect possible regressions as well as used for
237analysis of the build output. For more information on using Build 237analysis of the build output. For more information on using Build
238History, see the 238History, see the
239":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" 239":ref:`dev-manual/common-tasks:maintaining build output quality`"
240section in the Yocto Project Development Tasks Manual. 240section in the Yocto Project Development Tasks Manual.
241 241
242.. _ref-classes-buildstats: 242.. _ref-classes-buildstats:
@@ -458,7 +458,7 @@ staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``.
458==================== 458====================
459 459
460The ``devshell`` class adds the ``do_devshell`` task. Distribution 460The ``devshell`` class adds the ``do_devshell`` task. Distribution
461policy dictates whether to include this class. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" 461policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`"
462section in the Yocto Project Development Tasks Manual for more 462section in the Yocto Project Development Tasks Manual for more
463information about using ``devshell``. 463information about using ``devshell``.
464 464
@@ -586,7 +586,7 @@ For more information on the ``externalsrc`` class, see the comments in
586``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. 586``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`.
587For information on how to use the 587For information on how to use the
588``externalsrc`` class, see the 588``externalsrc`` class, see the
589":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" 589":ref:`dev-manual/common-tasks:building software from an external source`"
590section in the Yocto Project Development Tasks Manual. 590section in the Yocto Project Development Tasks Manual.
591 591
592.. _ref-classes-extrausers: 592.. _ref-classes-extrausers:
@@ -927,7 +927,7 @@ then one or more image files are created.
927 install into the image. 927 install into the image.
928 928
929For information on customizing images, see the 929For information on customizing images, see the
930":ref:`dev-manual/dev-manual-common-tasks:customizing images`" section 930":ref:`dev-manual/common-tasks:customizing images`" section
931in the Yocto Project Development Tasks Manual. For information on how 931in the Yocto Project Development Tasks Manual. For information on how
932images are created, see the 932images are created, see the
933":ref:`overview-manual/overview-manual-concepts:images`" section in the 933":ref:`overview-manual/overview-manual-concepts:images`" section in the
@@ -1344,7 +1344,7 @@ packages such as ``kernel-vmlinux``.
1344The ``kernel`` class contains logic that allows you to embed an initial 1344The ``kernel`` class contains logic that allows you to embed an initial
1345RAM filesystem (initramfs) image when you build the kernel image. For 1345RAM filesystem (initramfs) image when you build the kernel image. For
1346information on how to build an initramfs, see the 1346information on how to build an initramfs, see the
1347":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section in 1347":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in
1348the Yocto Project Development Tasks Manual. 1348the Yocto Project Development Tasks Manual.
1349 1349
1350Various other classes are used by the ``kernel`` and ``module`` classes 1350Various other classes are used by the ``kernel`` and ``module`` classes
@@ -1620,7 +1620,7 @@ different target optimizations or target architectures and installing
1620them side-by-side in the same image. 1620them side-by-side in the same image.
1621 1621
1622For more information on using the Multilib feature, see the 1622For more information on using the Multilib feature, see the
1623":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`" 1623":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`"
1624section in the Yocto Project Development Tasks Manual. 1624section in the Yocto Project Development Tasks Manual.
1625 1625
1626.. _ref-classes-native: 1626.. _ref-classes-native:
@@ -1732,7 +1732,7 @@ package manager (NPM) <https://en.wikipedia.org/wiki/Npm_(software)>`__.
1732 fetcher to have dependencies fetched and packaged automatically. 1732 fetcher to have dependencies fetched and packaged automatically.
1733 1733
1734For information on how to create NPM packages, see the 1734For information on how to create NPM packages, see the
1735":ref:`dev-manual/dev-manual-common-tasks:creating node package manager (npm) packages`" 1735":ref:`dev-manual/common-tasks:creating node package manager (npm) packages`"
1736section in the Yocto Project Development Tasks Manual. 1736section in the Yocto Project Development Tasks Manual.
1737 1737
1738.. _ref-classes-oelint: 1738.. _ref-classes-oelint:
@@ -1802,7 +1802,7 @@ If you take the optional step to set up a repository (package feed) on
1802the development host that can be used by DNF, you can install packages 1802the development host that can be used by DNF, you can install packages
1803from the feed while you are running the image on the target (i.e. 1803from the feed while you are running the image on the target (i.e.
1804runtime installation of packages). For more information, see the 1804runtime installation of packages). For more information, see the
1805":ref:`dev-manual/dev-manual-common-tasks:using runtime package management`" 1805":ref:`dev-manual/common-tasks:using runtime package management`"
1806section in the Yocto Project Development Tasks Manual. 1806section in the Yocto Project Development Tasks Manual.
1807 1807
1808The package-specific class you choose can affect build-time performance 1808The package-specific class you choose can affect build-time performance
@@ -1921,7 +1921,7 @@ so forth). It is highly recommended that all package group recipes
1921inherit this class. 1921inherit this class.
1922 1922
1923For information on how to use this class, see the 1923For information on how to use this class, see the
1924":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom package groups`" 1924":ref:`dev-manual/common-tasks:customizing images using custom package groups`"
1925section in the Yocto Project Development Tasks Manual. 1925section in the Yocto Project Development Tasks Manual.
1926 1926
1927Previously, this class was called the ``task`` class. 1927Previously, this class was called the ``task`` class.
@@ -2080,7 +2080,7 @@ The ``primport`` class provides functionality for importing
2080================== 2080==================
2081 2081
2082The ``prserv`` class provides functionality for using a :ref:`PR 2082The ``prserv`` class provides functionality for using a :ref:`PR
2083service <dev-manual/dev-manual-common-tasks:working with a pr service>` in order to 2083service <dev-manual/common-tasks:working with a pr service>` in order to
2084automatically manage the incrementing of the :term:`PR` 2084automatically manage the incrementing of the :term:`PR`
2085variable for each recipe. 2085variable for each recipe.
2086 2086
@@ -2100,7 +2100,7 @@ runtime tests for recipes that build software that provides these tests.
2100This class is intended to be inherited by individual recipes. However, 2100This class is intended to be inherited by individual recipes. However,
2101the class' functionality is largely disabled unless "ptest" appears in 2101the class' functionality is largely disabled unless "ptest" appears in
2102:term:`DISTRO_FEATURES`. See the 2102:term:`DISTRO_FEATURES`. See the
2103":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" 2103":ref:`dev-manual/common-tasks:testing packages with ptest`"
2104section in the Yocto Project Development Tasks Manual for more information 2104section in the Yocto Project Development Tasks Manual for more information
2105on ptest. 2105on ptest.
2106 2106
@@ -2113,7 +2113,7 @@ Enables package tests (ptests) specifically for GNOME packages, which
2113have tests intended to be executed with ``gnome-desktop-testing``. 2113have tests intended to be executed with ``gnome-desktop-testing``.
2114 2114
2115For information on setting up and running ptests, see the 2115For information on setting up and running ptests, see the
2116":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" 2116":ref:`dev-manual/common-tasks:testing packages with ptest`"
2117section in the Yocto Project Development Tasks Manual. 2117section in the Yocto Project Development Tasks Manual.
2118 2118
2119.. _ref-classes-python-dir: 2119.. _ref-classes-python-dir:
@@ -2199,7 +2199,7 @@ override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows:
2199======================== 2199========================
2200 2200
2201The ``report-error`` class supports enabling the :ref:`error reporting 2201The ``report-error`` class supports enabling the :ref:`error reporting
2202tool <dev-manual/dev-manual-common-tasks:using the error reporting tool>`", 2202tool <dev-manual/common-tasks:using the error reporting tool>`",
2203which allows you to submit build error information to a central database. 2203which allows you to submit build error information to a central database.
2204 2204
2205The class collects debug information for recipe, recipe version, task, 2205The class collects debug information for recipe, recipe version, task,
@@ -2554,7 +2554,7 @@ unless you have set
2554:term:`SYSTEMD_AUTO_ENABLE` to "disable". 2554:term:`SYSTEMD_AUTO_ENABLE` to "disable".
2555 2555
2556For more information on ``systemd``, see the 2556For more information on ``systemd``, see the
2557":ref:`dev-manual/dev-manual-common-tasks:selecting an initialization manager`" 2557":ref:`dev-manual/common-tasks:selecting an initialization manager`"
2558section in the Yocto Project Development Tasks Manual. 2558section in the Yocto Project Development Tasks Manual.
2559 2559
2560.. _ref-classes-systemd-boot: 2560.. _ref-classes-systemd-boot:
@@ -2631,7 +2631,7 @@ runs tests on an image after the image is constructed (i.e.
2631:term:`TESTIMAGE_AUTO` must be set to "1"). 2631:term:`TESTIMAGE_AUTO` must be set to "1").
2632 2632
2633For information on how to enable, run, and create new tests, see the 2633For information on how to enable, run, and create new tests, see the
2634":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 2634":ref:`dev-manual/common-tasks:performing automated runtime testing`"
2635section in the Yocto Project Development Tasks Manual. 2635section in the Yocto Project Development Tasks Manual.
2636 2636
2637.. _ref-classes-testsdk: 2637.. _ref-classes-testsdk:
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst
index 83861d271c..11b4cb5d5b 100644
--- a/documentation/ref-manual/ref-devtool-reference.rst
+++ b/documentation/ref-manual/ref-devtool-reference.rst
@@ -413,7 +413,7 @@ Upgrading a Recipe
413As software matures, upstream recipes are upgraded to newer versions. As 413As software matures, upstream recipes are upgraded to newer versions. As
414a developer, you need to keep your local recipes up-to-date with the 414a developer, you need to keep your local recipes up-to-date with the
415upstream version releases. Several methods exist by which you can 415upstream version releases. Several methods exist by which you can
416upgrade recipes. You can read about them in the ":ref:`dev-manual/dev-manual-common-tasks:upgrading recipes`" 416upgrade recipes. You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`"
417section of the Yocto Project Development Tasks Manual. This section 417section of the Yocto Project Development Tasks Manual. This section
418overviews the ``devtool upgrade`` command. 418overviews the ``devtool upgrade`` command.
419 419
@@ -441,7 +441,7 @@ You 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/sdk-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/dev-manual-common-tasks:using \`\`devtool upgrade\`\``" 444how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``"
445section in the Yocto Project Development Tasks Manual. 445section in the Yocto Project Development Tasks Manual.
446 446
447.. _devtool-resetting-a-recipe: 447.. _devtool-resetting-a-recipe:
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst
index 6c85c24181..cb4b57436d 100644
--- a/documentation/ref-manual/ref-features.rst
+++ b/documentation/ref-manual/ref-features.rst
@@ -156,7 +156,7 @@ metadata:
156 156
157- *ptest:* Enables building the package tests where supported by 157- *ptest:* Enables building the package tests where supported by
158 individual recipes. For more information on package tests, see the 158 individual recipes. For more information on package tests, see the
159 ":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" section 159 ":ref:`dev-manual/common-tasks:testing packages with ptest`" section
160 in the Yocto Project Development Tasks Manual. 160 in the Yocto Project Development Tasks Manual.
161 161
162- *smbfs:* Include SMB networks client support (for mounting 162- *smbfs:* Include SMB networks client support (for mounting
@@ -236,7 +236,7 @@ The following image features are available for all images:
236 236
237- *read-only-rootfs:* Creates an image whose root filesystem is 237- *read-only-rootfs:* Creates an image whose root filesystem is
238 read-only. See the 238 read-only. See the
239 ":ref:`dev-manual/dev-manual-common-tasks:creating a read-only root filesystem`" 239 ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`"
240 section in the Yocto Project Development Tasks Manual for more 240 section in the Yocto Project Development Tasks Manual for more
241 information. 241 information.
242 242
@@ -273,7 +273,7 @@ these valid features is as follows:
273 273
274- *tools-debug:* Installs debugging tools such as ``strace`` and 274- *tools-debug:* Installs debugging tools such as ``strace`` and
275 ``gdb``. For information on GDB, see the 275 ``gdb``. For information on GDB, see the
276 ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section 276 ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
277 in the Yocto Project Development Tasks Manual. For information on 277 in the Yocto Project Development Tasks Manual. For information on
278 tracing and profiling, see the :doc:`/profile-manual/index`. 278 tracing and profiling, see the :doc:`/profile-manual/index`.
279 279
diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst
index 56ec8562f8..5e9374eae7 100644
--- a/documentation/ref-manual/ref-images.rst
+++ b/documentation/ref-manual/ref-images.rst
@@ -122,7 +122,7 @@ Following is a list of supported recipes:
122 deployed to a separate partition so that you can boot into it and use 122 deployed to a separate partition so that you can boot into it and use
123 it to deploy a second image to be tested. You can find more 123 it to deploy a second image to be tested. You can find more
124 information about runtime testing in the 124 information about runtime testing in the
125 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 125 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
126 section in the Yocto Project Development Tasks Manual. 126 section in the Yocto Project Development Tasks Manual.
127 127
128- ``core-image-testmaster-initramfs``: A RAM-based Initial Root 128- ``core-image-testmaster-initramfs``: A RAM-based Initial Root
@@ -132,7 +132,7 @@ Following is a list of supported recipes:
132- ``core-image-weston``: A very basic Wayland image with a terminal. 132- ``core-image-weston``: A very basic Wayland image with a terminal.
133 This image provides the Wayland protocol libraries and the reference 133 This image provides the Wayland protocol libraries and the reference
134 Weston compositor. For more information, see the 134 Weston compositor. For more information, see the
135 ":ref:`dev-manual/dev-manual-common-tasks:using wayland and weston`" 135 ":ref:`dev-manual/common-tasks:using wayland and weston`"
136 section in the Yocto Project Development Tasks Manual. 136 section in the Yocto Project Development Tasks Manual.
137 137
138- ``core-image-x11``: A very basic X11 image with a terminal. 138- ``core-image-x11``: A very basic X11 image with a terminal.
diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst
index 7f6d4ebe1c..bb9c0460f3 100644
--- a/documentation/ref-manual/ref-kickstart.rst
+++ b/documentation/ref-manual/ref-kickstart.rst
@@ -79,7 +79,7 @@ the ``part`` and ``partition`` commands:
79 source of the data that populates the partition. The most common 79 source of the data that populates the partition. The most common
80 value for this option is "rootfs", but you can use any value that 80 value for this option is "rootfs", but you can use any value that
81 maps to a valid source plugin. For information on the source plugins, 81 maps to a valid source plugin. For information on the source plugins,
82 see the ":ref:`dev-manual/dev-manual-common-tasks:using the wic plugin interface`" 82 see the ":ref:`dev-manual/common-tasks:using the wic plugin interface`"
83 section in the Yocto Project Development Tasks Manual. 83 section in the Yocto Project Development Tasks Manual.
84 84
85 If you use ``--source rootfs``, Wic creates a partition as large as 85 If you use ``--source rootfs``, Wic creates a partition as large as
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst
index ec6d233877..54cd9510f6 100644
--- a/documentation/ref-manual/ref-release-process.rst
+++ b/documentation/ref-manual/ref-release-process.rst
@@ -106,7 +106,7 @@ Additionally, because the test strategies are visible to you as a
106developer, you can validate your projects. This section overviews the 106developer, you can validate your projects. This section overviews the
107available test infrastructure used in the Yocto Project. For information 107available test infrastructure used in the Yocto Project. For information
108on how to run available tests on your projects, see the 108on how to run available tests on your projects, see the
109":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 109":ref:`dev-manual/common-tasks:performing automated runtime testing`"
110section in the Yocto Project Development Tasks Manual. 110section in the Yocto Project Development Tasks Manual.
111 111
112The QA/testing infrastructure is woven into the project to the point 112The QA/testing infrastructure is woven into the project to the point
@@ -128,12 +128,12 @@ consists of the following pieces:
128 128
129- :ref:`testimage.bbclass <ref-classes-testimage*>`: This class 129- :ref:`testimage.bbclass <ref-classes-testimage*>`: This class
130 performs runtime testing of images after they are built. The tests 130 performs runtime testing of images after they are built. The tests
131 are usually used with :doc:`QEMU </dev-manual/dev-manual-qemu>` 131 are usually used with :doc:`QEMU </dev-manual/qemu>`
132 to boot the images and check the combined runtime result boot 132 to boot the images and check the combined runtime result boot
133 operation and functions. However, the test can also use the IP 133 operation and functions. However, the test can also use the IP
134 address of a machine to test. 134 address of a machine to test.
135 135
136- :ref:`ptest <dev-manual/dev-manual-common-tasks:testing packages with ptest>`: 136- :ref:`ptest <dev-manual/common-tasks:testing packages with ptest>`:
137 Runs tests against packages produced during the build for a given 137 Runs tests against packages produced during the build for a given
138 piece of software. The test allows the packages to be be run within a 138 piece of software. The test allows the packages to be be run within a
139 target image. 139 target image.
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index d3a231554f..b681e8233f 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -12,7 +12,7 @@ and directories.
12 12
13For information on how to establish a local Source Directory on your 13For information on how to establish a local Source Directory on your
14development system, see the 14development system, see the
15":ref:`dev-manual/dev-manual-start:locating yocto project source files`" 15":ref:`dev-manual/start:locating yocto project source files`"
16section in the Yocto Project Development Tasks Manual. 16section in the Yocto Project Development Tasks Manual.
17 17
18.. note:: 18.. note::
@@ -176,7 +176,7 @@ within the :term:`Source Directory`. If you design a
176custom distribution, you can include your own version of this 176custom distribution, you can include your own version of this
177configuration file to mention the targets defined by your distribution. 177configuration file to mention the targets defined by your distribution.
178See the 178See the
179":ref:`dev-manual/dev-manual-common-tasks:creating a custom template configuration directory`" 179":ref:`dev-manual/common-tasks:creating a custom template configuration directory`"
180section in the Yocto Project Development Tasks Manual for more 180section in the Yocto Project Development Tasks Manual for more
181information. 181information.
182 182
@@ -193,7 +193,7 @@ Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`:
193The OpenEmbedded build system uses the template configuration files, which 193The OpenEmbedded build system uses the template configuration files, which
194are found by default in the ``meta-poky/conf/`` directory in the Source 194are found by default in the ``meta-poky/conf/`` directory in the Source
195Directory. See the 195Directory. See the
196":ref:`dev-manual/dev-manual-common-tasks:creating a custom template configuration directory`" 196":ref:`dev-manual/common-tasks:creating a custom template configuration directory`"
197section in the Yocto Project Development Tasks Manual for more 197section in the Yocto Project Development Tasks Manual for more
198information. 198information.
199 199
@@ -236,7 +236,7 @@ The OpenEmbedded build system creates this directory when you enable
236build history via the ``buildhistory`` class file. The directory 236build history via the ``buildhistory`` class file. The directory
237organizes build information into image, packages, and SDK 237organizes build information into image, packages, and SDK
238subdirectories. For information on the build history feature, see the 238subdirectories. For information on the build history feature, see the
239":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" 239":ref:`dev-manual/common-tasks:maintaining build output quality`"
240section in the Yocto Project Development Tasks Manual. 240section in the Yocto Project Development Tasks Manual.
241 241
242.. _structure-build-conf-local.conf: 242.. _structure-build-conf-local.conf:
@@ -292,7 +292,7 @@ file, it uses ``sed`` to substitute final
292---------------------------- 292----------------------------
293 293
294This configuration file defines 294This configuration file defines
295:ref:`layers <dev-manual/dev-manual-common-tasks:understanding and creating layers>`, 295:ref:`layers <dev-manual/common-tasks:understanding and creating layers>`,
296which are directory trees, traversed (or walked) by BitBake. The 296which are directory trees, traversed (or walked) by BitBake. The
297``bblayers.conf`` file uses the :term:`BBLAYERS` 297``bblayers.conf`` file uses the :term:`BBLAYERS`
298variable to list the layers BitBake tries to find. 298variable to list the layers BitBake tries to find.
@@ -438,7 +438,7 @@ directory contains sub-directories for ``bash``, ``busybox``, and
438``glibc`` (among others) that in turn contain appropriate ``COPYING`` 438``glibc`` (among others) that in turn contain appropriate ``COPYING``
439license files with other licensing information. For information on 439license files with other licensing information. For information on
440licensing, see the 440licensing, see the
441":ref:`dev-manual/dev-manual-common-tasks:maintaining open source license compliance during your product's lifecycle`" 441":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`"
442section in the Yocto Project Development Tasks Manual. 442section in the Yocto Project Development Tasks Manual.
443 443
444.. _structure-build-tmp-deploy-images: 444.. _structure-build-tmp-deploy-images:
@@ -577,7 +577,7 @@ built within the Yocto Project. For this package, a work directory of
577``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred 577``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred
578to as the ``WORKDIR``, is created. Within this directory, the source is 578to as the ``WORKDIR``, is created. Within this directory, the source is
579unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. 579unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt.
580(See the ":ref:`dev-manual/dev-manual-common-tasks:using quilt in your workflow`" section in 580(See the ":ref:`dev-manual/common-tasks:using quilt in your workflow`" section in
581the Yocto Project Development Tasks Manual for more information.) Within 581the Yocto Project Development Tasks Manual for more information.) Within
582the ``linux-qemux86-standard-build`` directory, standard Quilt 582the ``linux-qemux86-standard-build`` directory, standard Quilt
583directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and 583directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst
index 2c7c1e0754..d162c9bad2 100644
--- a/documentation/ref-manual/ref-system-requirements.rst
+++ b/documentation/ref-manual/ref-system-requirements.rst
@@ -94,7 +94,7 @@ distributions:
94 interested in hearing about your experience. For information on 94 interested in hearing about your experience. For information on
95 how to submit a bug, see the Yocto Project 95 how to submit a bug, see the Yocto Project
96 :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` 96 :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
97 and the ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" 97 and the ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`"
98 section in the Yocto Project Development Tasks Manual. 98 section in the Yocto Project Development Tasks Manual.
99 99
100 100
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index 9fde9a8378..89731d459c 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -351,7 +351,7 @@ applied as a patch by default except for the ``patch_file5`` patch.
351You can find out more about the patching process in the 351You can find out more about the patching process in the
352":ref:`overview-manual/overview-manual-concepts:patching`" section in 352":ref:`overview-manual/overview-manual-concepts:patching`" section in
353the Yocto Project Overview and Concepts Manual and the 353the Yocto Project Overview and Concepts Manual and the
354":ref:`dev-manual/dev-manual-common-tasks:patching code`" section in the 354":ref:`dev-manual/common-tasks:patching code`" section in the
355Yocto Project Development Tasks Manual. 355Yocto Project Development Tasks Manual.
356 356
357.. _ref-tasks-populate_lic: 357.. _ref-tasks-populate_lic:
@@ -567,7 +567,7 @@ scratch is guaranteed.
567Starts a shell in which an interactive Python interpreter allows you to 567Starts a shell in which an interactive Python interpreter allows you to
568interact with the BitBake build environment. From within this shell, you 568interact with the BitBake build environment. From within this shell, you
569can directly examine and set bits from the data store and execute 569can directly examine and set bits from the data store and execute
570functions as if within the BitBake environment. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development python shell`" section in 570functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a development python shell`" section in
571the Yocto Project Development Tasks Manual for more information about 571the Yocto Project Development Tasks Manual for more information about
572using ``devpyshell``. 572using ``devpyshell``.
573 573
@@ -577,7 +577,7 @@ using ``devpyshell``.
577--------------- 577---------------
578 578
579Starts a shell whose environment is set up for development, debugging, 579Starts a shell whose environment is set up for development, debugging,
580or both. See the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" section in the 580or both. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the
581Yocto Project Development Tasks Manual for more information about using 581Yocto Project Development Tasks Manual for more information about using
582``devshell``. 582``devshell``.
583 583
@@ -642,7 +642,7 @@ information on how the root filesystem is created.
642 642
643Boots an image and performs runtime tests within the image. For 643Boots an image and performs runtime tests within the image. For
644information on automatically testing images, see the 644information on automatically testing images, see the
645":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 645":ref:`dev-manual/common-tasks:performing automated runtime testing`"
646section in the Yocto Project Development Tasks Manual. 646section in the Yocto Project Development Tasks Manual.
647 647
648.. _ref-tasks-testimage_auto: 648.. _ref-tasks-testimage_auto:
@@ -655,7 +655,7 @@ after it has been built. This task is enabled when you set
655:term:`TESTIMAGE_AUTO` equal to "1". 655:term:`TESTIMAGE_AUTO` equal to "1".
656 656
657For information on automatically testing images, see the 657For information on automatically testing images, see the
658":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 658":ref:`dev-manual/common-tasks:performing automated runtime testing`"
659section in the Yocto Project Development Tasks Manual. 659section in the Yocto Project Development Tasks Manual.
660 660
661Kernel-Related Tasks 661Kernel-Related Tasks
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst
index 6f0facf728..ba1930ebda 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -21,7 +21,7 @@ universal, the list includes them just in case:
21 21
22 Information in append files extends or overrides the information in the 22 Information in append files extends or overrides the information in the
23 similarly-named recipe file. For an example of an append file in use, see 23 similarly-named recipe file. For an example of an append file in use, see
24 the ":ref:`dev-manual/dev-manual-common-tasks:Using .bbappend Files in 24 the ":ref:`dev-manual/common-tasks:Using .bbappend Files in
25 Your Layer`" section in the Yocto Project Development Tasks Manual. 25 Your Layer`" section in the Yocto Project Development Tasks Manual.
26 26
27 When you name an append file, you can use the "``%``" wildcard character 27 When you name an append file, you can use the "``%``" wildcard character
@@ -192,7 +192,7 @@ universal, the list includes them just in case:
192 ":ref:`overview-manual/overview-manual-yp-intro:The Yocto Project Layer 192 ":ref:`overview-manual/overview-manual-yp-intro:The Yocto Project Layer
193 Model`" section in the Yocto Project Overview and Concepts Manual. For 193 Model`" section in the Yocto Project Overview and Concepts Manual. For
194 more detailed information on layers, see the 194 more detailed information on layers, see the
195 ":ref:`dev-manual/dev-manual-common-tasks:Understanding and Creating 195 ":ref:`dev-manual/common-tasks:Understanding and Creating
196 Layers`" section in the Yocto Project Development Tasks Manual. For a 196 Layers`" section in the Yocto Project Development Tasks Manual. For a
197 discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP 197 discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP
198 Layers`" section in the Yocto Project Board Support Packages (BSP) 198 Layers`" section in the Yocto Project Board Support Packages (BSP)
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 8411989b69..65f64b91a5 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -239,7 +239,7 @@ system and gives an overview of their function and contents.
239 so that it does contain ``${SRCPV}``. 239 so that it does contain ``${SRCPV}``.
240 240
241 For more information see the 241 For more information see the
242 ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" 242 ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`"
243 section in the Yocto Project Development Tasks Manual. 243 section in the Yocto Project Development Tasks Manual.
244 244
245 :term:`AVAILABLE_LICENSES` 245 :term:`AVAILABLE_LICENSES`
@@ -261,7 +261,7 @@ system and gives an overview of their function and contents.
261 The list simply presents the tunes that are available. Not all tunes 261 The list simply presents the tunes that are available. Not all tunes
262 may be compatible with a particular machine configuration, or with 262 may be compatible with a particular machine configuration, or with
263 each other in a 263 each other in a
264 :ref:`Multilib <dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image>` 264 :ref:`Multilib <dev-manual/common-tasks:combining multiple versions of library files into one image>`
265 configuration. 265 configuration.
266 266
267 To add a tune to the list, be sure to append it with spaces using the 267 To add a tune to the list, be sure to append it with spaces using the
@@ -317,7 +317,7 @@ system and gives an overview of their function and contents.
317 :term:`BASE_LIB` 317 :term:`BASE_LIB`
318 The library directory name for the CPU or Application Binary 318 The library directory name for the CPU or Application Binary
319 Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib 319 Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib
320 context. See the ":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`" 320 context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`"
321 section in the Yocto Project Development Tasks Manual for information 321 section in the Yocto Project Development Tasks Manual for information
322 on Multilib. 322 on Multilib.
323 323
@@ -545,7 +545,7 @@ system and gives an overview of their function and contents.
545 is not set higher than "20". 545 is not set higher than "20".
546 546
547 For more information on speeding up builds, see the 547 For more information on speeding up builds, see the
548 ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" 548 ":ref:`dev-manual/common-tasks:speeding up a build`"
549 section in the Yocto Project Development Tasks Manual. 549 section in the Yocto Project Development Tasks Manual.
550 550
551 :term:`BB_SERVER_TIMEOUT` 551 :term:`BB_SERVER_TIMEOUT`
@@ -746,7 +746,7 @@ system and gives an overview of their function and contents.
746 746
747 For information on how to use ``BBMULTICONFIG`` in an environment 747 For information on how to use ``BBMULTICONFIG`` in an environment
748 that supports building targets with multiple configurations, see the 748 that supports building targets with multiple configurations, see the
749 ":ref:`dev-manual/dev-manual-common-tasks:building images for multiple targets using multiple configurations`" 749 ":ref:`dev-manual/common-tasks:building images for multiple targets using multiple configurations`"
750 section in the Yocto Project Development Tasks Manual. 750 section in the Yocto Project Development Tasks Manual.
751 751
752 :term:`BBPATH` 752 :term:`BBPATH`
@@ -1002,7 +1002,7 @@ system and gives an overview of their function and contents.
1002 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1002 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
1003 class, this variable specifies the build history features to be 1003 class, this variable specifies the build history features to be
1004 enabled. For more information on how build history works, see the 1004 enabled. For more information on how build history works, see the
1005 ":ref:`dev-manual/dev-manual-common-tasks:maintaining build output quality`" 1005 ":ref:`dev-manual/common-tasks:maintaining build output quality`"
1006 section in the Yocto Project Development Tasks Manual. 1006 section in the Yocto Project Development Tasks Manual.
1007 1007
1008 You can specify these features in the form of a space-separated list: 1008 You can specify these features in the form of a space-separated list:
@@ -1299,7 +1299,7 @@ system and gives an overview of their function and contents.
1299 will be the aggregate of all of them. 1299 will be the aggregate of all of them.
1300 1300
1301 For information on creating an initramfs, see the 1301 For information on creating an initramfs, see the
1302 ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section 1302 ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
1303 in the Yocto Project Development Tasks Manual. 1303 in the Yocto Project Development Tasks Manual.
1304 1304
1305 :term:`CONFIG_SITE` 1305 :term:`CONFIG_SITE`
@@ -1402,7 +1402,7 @@ system and gives an overview of their function and contents.
1402 newly installed packages to an image, which might be most suitable for 1402 newly installed packages to an image, which might be most suitable for
1403 read-only filesystems that cannot be upgraded. See the 1403 read-only filesystems that cannot be upgraded. See the
1404 :term:`LICENSE_CREATE_PACKAGE` variable for additional information. 1404 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1405 You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" 1405 You can also reference the ":ref:`dev-manual/common-tasks:providing license text`"
1406 section in the Yocto Project Development Tasks Manual for 1406 section in the Yocto Project Development Tasks Manual for
1407 information on providing license text. 1407 information on providing license text.
1408 1408
@@ -1418,7 +1418,7 @@ system and gives an overview of their function and contents.
1418 newly installed packages to an image, which might be most suitable for 1418 newly installed packages to an image, which might be most suitable for
1419 read-only filesystems that cannot be upgraded. See the 1419 read-only filesystems that cannot be upgraded. See the
1420 :term:`LICENSE_CREATE_PACKAGE` variable for additional information. 1420 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1421 You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" 1421 You can also reference the ":ref:`dev-manual/common-tasks:providing license text`"
1422 section in the Yocto Project Development Tasks Manual for 1422 section in the Yocto Project Development Tasks Manual for
1423 information on providing license text. 1423 information on providing license text.
1424 1424
@@ -2029,7 +2029,7 @@ system and gives an overview of their function and contents.
2029 When used with the :ref:`report-error <ref-classes-report-error>` 2029 When used with the :ref:`report-error <ref-classes-report-error>`
2030 class, specifies the path used for storing the debug files created by 2030 class, specifies the path used for storing the debug files created by
2031 the :ref:`error reporting 2031 the :ref:`error reporting
2032 tool <dev-manual/dev-manual-common-tasks:using the error reporting tool>`, which 2032 tool <dev-manual/common-tasks:using the error reporting tool>`, which
2033 allows you to submit build errors you encounter to a central 2033 allows you to submit build errors you encounter to a central
2034 database. By default, the value of this variable is 2034 database. By default, the value of this variable is
2035 ``${``\ :term:`LOG_DIR`\ ``}/error-report``. 2035 ``${``\ :term:`LOG_DIR`\ ``}/error-report``.
@@ -2129,7 +2129,7 @@ system and gives an overview of their function and contents.
2129 For more information on ``externalsrc.bbclass``, see the 2129 For more information on ``externalsrc.bbclass``, see the
2130 ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You 2130 ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You
2131 can also find information on how to use this variable in the 2131 can also find information on how to use this variable in the
2132 ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" 2132 ":ref:`dev-manual/common-tasks:building software from an external source`"
2133 section in the Yocto Project Development Tasks Manual. 2133 section in the Yocto Project Development Tasks Manual.
2134 2134
2135 :term:`EXTERNALSRC_BUILD` 2135 :term:`EXTERNALSRC_BUILD`
@@ -2143,7 +2143,7 @@ system and gives an overview of their function and contents.
2143 For more information on ``externalsrc.bbclass``, see the 2143 For more information on ``externalsrc.bbclass``, see the
2144 ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You 2144 ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You
2145 can also find information on how to use this variable in the 2145 can also find information on how to use this variable in the
2146 ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" 2146 ":ref:`dev-manual/common-tasks:building software from an external source`"
2147 section in the Yocto Project Development Tasks Manual. 2147 section in the Yocto Project Development Tasks Manual.
2148 2148
2149 :term:`EXTRA_AUTORECONF` 2149 :term:`EXTRA_AUTORECONF`
@@ -2181,7 +2181,7 @@ system and gives an overview of their function and contents.
2181 useful if you want to develop against the libraries in the image. 2181 useful if you want to develop against the libraries in the image.
2182 - "read-only-rootfs" - Creates an image whose root filesystem is 2182 - "read-only-rootfs" - Creates an image whose root filesystem is
2183 read-only. See the 2183 read-only. See the
2184 ":ref:`dev-manual/dev-manual-common-tasks:creating a read-only root filesystem`" 2184 ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`"
2185 section in the Yocto Project Development Tasks Manual for more 2185 section in the Yocto Project Development Tasks Manual for more
2186 information 2186 information
2187 - "tools-debug" - Adds debugging tools such as gdb and strace. 2187 - "tools-debug" - Adds debugging tools such as gdb and strace.
@@ -2194,7 +2194,7 @@ system and gives an overview of their function and contents.
2194 Project, see the ":ref:`ref-features-image`" section. 2194 Project, see the ":ref:`ref-features-image`" section.
2195 2195
2196 For an example that shows how to customize your image by using this 2196 For an example that shows how to customize your image by using this
2197 variable, see the ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" 2197 variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
2198 section in the Yocto Project Development Tasks Manual. 2198 section in the Yocto Project Development Tasks Manual.
2199 2199
2200 :term:`EXTRA_IMAGECMD` 2200 :term:`EXTRA_IMAGECMD`
@@ -2511,7 +2511,7 @@ system and gives an overview of their function and contents.
2511 You can find out more about the patching process in the 2511 You can find out more about the patching process in the
2512 ":ref:`overview-manual/overview-manual-concepts:patching`" section 2512 ":ref:`overview-manual/overview-manual-concepts:patching`" section
2513 in the Yocto Project Overview and Concepts Manual and the 2513 in the Yocto Project Overview and Concepts Manual and the
2514 ":ref:`dev-manual/dev-manual-common-tasks:patching code`" section in 2514 ":ref:`dev-manual/common-tasks:patching code`" section in
2515 the Yocto Project Development Tasks Manual. See the 2515 the Yocto Project Development Tasks Manual. See the
2516 :ref:`ref-tasks-patch` task as well. 2516 :ref:`ref-tasks-patch` task as well.
2517 2517
@@ -2904,7 +2904,7 @@ system and gives an overview of their function and contents.
2904 the same files into a ``boot`` directory within the target partition. 2904 the same files into a ``boot`` directory within the target partition.
2905 2905
2906 You can find information on how to use the Wic tool in the 2906 You can find information on how to use the Wic tool in the
2907 ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" 2907 ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
2908 section of the Yocto Project Development Tasks Manual. Reference 2908 section of the Yocto Project Development Tasks Manual. Reference
2909 material for Wic is located in the 2909 material for Wic is located in the
2910 ":doc:`/ref-manual/ref-kickstart`" chapter. 2910 ":doc:`/ref-manual/ref-kickstart`" chapter.
@@ -2940,7 +2940,7 @@ system and gives an overview of their function and contents.
2940 the same files into a ``boot`` directory within the target partition. 2940 the same files into a ``boot`` directory within the target partition.
2941 2941
2942 You can find information on how to use the Wic tool in the 2942 You can find information on how to use the Wic tool in the
2943 ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" 2943 ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
2944 section of the Yocto Project Development Tasks Manual. Reference 2944 section of the Yocto Project Development Tasks Manual. Reference
2945 material for Wic is located in the 2945 material for Wic is located in the
2946 ":doc:`/ref-manual/ref-kickstart`" chapter. 2946 ":doc:`/ref-manual/ref-kickstart`" chapter.
@@ -3000,7 +3000,7 @@ system and gives an overview of their function and contents.
3000 the ":ref:`ref-features-image`" section. 3000 the ":ref:`ref-features-image`" section.
3001 3001
3002 For an example that shows how to customize your image by using this 3002 For an example that shows how to customize your image by using this
3003 variable, see the ":ref:`dev-manual/dev-manual-common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" 3003 variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``"
3004 section in the Yocto Project Development Tasks Manual. 3004 section in the Yocto Project Development Tasks Manual.
3005 3005
3006 :term:`IMAGE_FSTYPES` 3006 :term:`IMAGE_FSTYPES`
@@ -3058,7 +3058,7 @@ system and gives an overview of their function and contents.
3058 allows the initial RAM filesystem (initramfs) recipe to use a 3058 allows the initial RAM filesystem (initramfs) recipe to use a
3059 fixed set of packages and not be affected by ``IMAGE_INSTALL``. 3059 fixed set of packages and not be affected by ``IMAGE_INSTALL``.
3060 For information on creating an initramfs, see the 3060 For information on creating an initramfs, see the
3061 ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" 3061 ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`"
3062 section in the Yocto Project Development Tasks Manual. 3062 section in the Yocto Project Development Tasks Manual.
3063 3063
3064 - Using ``IMAGE_INSTALL`` with the 3064 - Using ``IMAGE_INSTALL`` with the
@@ -3554,7 +3554,7 @@ system and gives an overview of their function and contents.
3554 :term:`INITRAMFS_IMAGE_BUNDLE` 3554 :term:`INITRAMFS_IMAGE_BUNDLE`
3555 variable, which allows the generated image to be bundled inside the 3555 variable, which allows the generated image to be bundled inside the
3556 kernel image. Additionally, for information on creating an initramfs 3556 kernel image. Additionally, for information on creating an initramfs
3557 image, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section 3557 image, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
3558 in the Yocto Project Development Tasks Manual. 3558 in the Yocto Project Development Tasks Manual.
3559 3559
3560 :term:`INITRAMFS_IMAGE_BUNDLE` 3560 :term:`INITRAMFS_IMAGE_BUNDLE`
@@ -3602,7 +3602,7 @@ system and gives an overview of their function and contents.
3602 See the 3602 See the
3603 :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>` 3603 :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>`
3604 file for additional information. Also, for information on creating an 3604 file for additional information. Also, for information on creating an
3605 initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section 3605 initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
3606 in the Yocto Project Development Tasks Manual. 3606 in the Yocto Project Development Tasks Manual.
3607 3607
3608 :term:`INITRAMFS_LINK_NAME` 3608 :term:`INITRAMFS_LINK_NAME`
@@ -4191,7 +4191,7 @@ system and gives an overview of their function and contents.
4191 The OpenEmbedded build system produces a warning if the variable 4191 The OpenEmbedded build system produces a warning if the variable
4192 is not set for any given layer. 4192 is not set for any given layer.
4193 4193
4194 See the ":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" 4194 See the ":ref:`dev-manual/common-tasks:creating your own layer`"
4195 section in the Yocto Project Development Tasks Manual. 4195 section in the Yocto Project Development Tasks Manual.
4196 4196
4197 :term:`LAYERVERSION` 4197 :term:`LAYERVERSION`
@@ -4240,7 +4240,7 @@ system and gives an overview of their function and contents.
4240 This variable must be defined for all recipes (unless 4240 This variable must be defined for all recipes (unless
4241 :term:`LICENSE` is set to "CLOSED"). 4241 :term:`LICENSE` is set to "CLOSED").
4242 4242
4243 For more information, see the ":ref:`dev-manual/dev-manual-common-tasks:tracking license changes`" 4243 For more information, see the ":ref:`dev-manual/common-tasks:tracking license changes`"
4244 section in the Yocto Project Development Tasks Manual. 4244 section in the Yocto Project Development Tasks Manual.
4245 4245
4246 :term:`LICENSE` 4246 :term:`LICENSE`
@@ -4306,7 +4306,7 @@ system and gives an overview of their function and contents.
4306 For related information on providing license text, see the 4306 For related information on providing license text, see the
4307 :term:`COPY_LIC_DIRS` variable, the 4307 :term:`COPY_LIC_DIRS` variable, the
4308 :term:`COPY_LIC_MANIFEST` variable, and the 4308 :term:`COPY_LIC_MANIFEST` variable, and the
4309 ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" 4309 ":ref:`dev-manual/common-tasks:providing license text`"
4310 section in the Yocto Project Development Tasks Manual. 4310 section in the Yocto Project Development Tasks Manual.
4311 4311
4312 :term:`LICENSE_FLAGS` 4312 :term:`LICENSE_FLAGS`
@@ -4319,7 +4319,7 @@ system and gives an overview of their function and contents.
4319 typically used to mark recipes that might require additional licenses 4319 typically used to mark recipes that might require additional licenses
4320 in order to be used in a commercial product. For more information, 4320 in order to be used in a commercial product. For more information,
4321 see the 4321 see the
4322 ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" 4322 ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`"
4323 section in the Yocto Project Development Tasks Manual. 4323 section in the Yocto Project Development Tasks Manual.
4324 4324
4325 :term:`LICENSE_FLAGS_WHITELIST` 4325 :term:`LICENSE_FLAGS_WHITELIST`
@@ -4327,7 +4327,7 @@ system and gives an overview of their function and contents.
4327 :term:`LICENSE_FLAGS` within a recipe should not 4327 :term:`LICENSE_FLAGS` within a recipe should not
4328 prevent that recipe from being built. This practice is otherwise 4328 prevent that recipe from being built. This practice is otherwise
4329 known as "whitelisting" license flags. For more information, see the 4329 known as "whitelisting" license flags. For more information, see the
4330 ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" 4330 ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`"
4331 section in the Yocto Project Development Tasks Manual. 4331 section in the Yocto Project Development Tasks Manual.
4332 4332
4333 :term:`LICENSE_PATH` 4333 :term:`LICENSE_PATH`
@@ -4890,7 +4890,7 @@ system and gives an overview of their function and contents.
4890 Controls how the OpenEmbedded build system spawns interactive 4890 Controls how the OpenEmbedded build system spawns interactive
4891 terminals on the host development system (e.g. using the BitBake 4891 terminals on the host development system (e.g. using the BitBake
4892 command with the ``-c devshell`` command-line option). For more 4892 command with the ``-c devshell`` command-line option). For more
4893 information, see the ":ref:`dev-manual/dev-manual-common-tasks:using a development shell`" section in 4893 information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in
4894 the Yocto Project Development Tasks Manual. 4894 the Yocto Project Development Tasks Manual.
4895 4895
4896 You can use the following values for the ``OE_TERMINAL`` variable: 4896 You can use the following values for the ``OE_TERMINAL`` variable:
@@ -4959,7 +4959,7 @@ system and gives an overview of their function and contents.
4959 4959
4960 An easy way to see what overrides apply is to search for ``OVERRIDES`` 4960 An easy way to see what overrides apply is to search for ``OVERRIDES``
4961 in the output of the ``bitbake -e`` command. See the 4961 in the output of the ``bitbake -e`` command. See the
4962 ":ref:`dev-manual/dev-manual-common-tasks:viewing variable values`" section in the Yocto 4962 ":ref:`dev-manual/common-tasks:viewing variable values`" section in the Yocto
4963 Project Development Tasks Manual for more information. 4963 Project Development Tasks Manual for more information.
4964 4964
4965 :term:`P` 4965 :term:`P`
@@ -4981,7 +4981,7 @@ system and gives an overview of their function and contents.
4981 specific by using the package name as a suffix. 4981 specific by using the package name as a suffix.
4982 4982
4983 You can find out more about applying this variable in the 4983 You can find out more about applying this variable in the
4984 ":ref:`dev-manual/dev-manual-common-tasks:adding custom metadata to packages`" 4984 ":ref:`dev-manual/common-tasks:adding custom metadata to packages`"
4985 section in the Yocto Project Development Tasks Manual. 4985 section in the Yocto Project Development Tasks Manual.
4986 4986
4987 :term:`PACKAGE_ARCH` 4987 :term:`PACKAGE_ARCH`
@@ -5079,7 +5079,7 @@ system and gives an overview of their function and contents.
5079 separate ``*-src`` pkg. This is the default behavior. 5079 separate ``*-src`` pkg. This is the default behavior.
5080 5080
5081 You can find out more about debugging using GDB by reading the 5081 You can find out more about debugging using GDB by reading the
5082 ":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section 5082 ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
5083 in the Yocto Project Development Tasks Manual. 5083 in the Yocto Project Development Tasks Manual.
5084 5084
5085 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` 5085 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY`
@@ -5243,7 +5243,7 @@ system and gives an overview of their function and contents.
5243 the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>` 5243 the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>`
5244 image. When working with an initial RAM filesystem (initramfs) image, 5244 image. When working with an initial RAM filesystem (initramfs) image,
5245 use the ``PACKAGE_INSTALL`` variable. For information on creating an 5245 use the ``PACKAGE_INSTALL`` variable. For information on creating an
5246 initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section 5246 initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section
5247 in the Yocto Project Development Tasks Manual. 5247 in the Yocto Project Development Tasks Manual.
5248 5248
5249 :term:`PACKAGE_INSTALL_ATTEMPTONLY` 5249 :term:`PACKAGE_INSTALL_ATTEMPTONLY`
@@ -5266,7 +5266,7 @@ system and gives an overview of their function and contents.
5266 ``PACKAGE_WRITE_DEPS``. 5266 ``PACKAGE_WRITE_DEPS``.
5267 5267
5268 For information on running post-installation scripts, see the 5268 For information on running post-installation scripts, see the
5269 ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" 5269 ":ref:`dev-manual/common-tasks:post-installation scripts`"
5270 section in the Yocto Project Development Tasks Manual. 5270 section in the Yocto Project Development Tasks Manual.
5271 5271
5272 :term:`PACKAGECONFIG` 5272 :term:`PACKAGECONFIG`
@@ -5423,7 +5423,7 @@ system and gives an overview of their function and contents.
5423 5423
5424 For an example of how to use the ``PACKAGES_DYNAMIC`` variable when 5424 For an example of how to use the ``PACKAGES_DYNAMIC`` variable when
5425 you are splitting packages, see the 5425 you are splitting packages, see the
5426 ":ref:`dev-manual/dev-manual-common-tasks:handling optional module packaging`" 5426 ":ref:`dev-manual/common-tasks:handling optional module packaging`"
5427 section in the Yocto Project Development Tasks Manual. 5427 section in the Yocto Project Development Tasks Manual.
5428 5428
5429 :term:`PACKAGESPLITFUNCS` 5429 :term:`PACKAGESPLITFUNCS`
@@ -5458,7 +5458,7 @@ system and gives an overview of their function and contents.
5458 the ``do_compile`` task that result in race conditions, you can clear 5458 the ``do_compile`` task that result in race conditions, you can clear
5459 the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For 5459 the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For
5460 information on addressing race conditions, see the 5460 information on addressing race conditions, see the
5461 ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" 5461 ":ref:`dev-manual/common-tasks:debugging parallel make races`"
5462 section in the Yocto Project Development Tasks Manual. 5462 section in the Yocto Project Development Tasks Manual.
5463 5463
5464 For single socket systems (i.e. one CPU), you should not have to 5464 For single socket systems (i.e. one CPU), you should not have to
@@ -5468,7 +5468,7 @@ system and gives an overview of their function and contents.
5468 not set higher than "-j 20". 5468 not set higher than "-j 20".
5469 5469
5470 For more information on speeding up builds, see the 5470 For more information on speeding up builds, see the
5471 ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" 5471 ":ref:`dev-manual/common-tasks:speeding up a build`"
5472 section in the Yocto Project Development Tasks Manual. 5472 section in the Yocto Project Development Tasks Manual.
5473 5473
5474 :term:`PARALLEL_MAKEINST` 5474 :term:`PARALLEL_MAKEINST`
@@ -5488,7 +5488,7 @@ system and gives an overview of their function and contents.
5488 the ``do_install`` task that result in race conditions, you can 5488 the ``do_install`` task that result in race conditions, you can
5489 clear the ``PARALLEL_MAKEINST`` variable within the recipe as a 5489 clear the ``PARALLEL_MAKEINST`` variable within the recipe as a
5490 workaround. For information on addressing race conditions, see the 5490 workaround. For information on addressing race conditions, see the
5491 ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" 5491 ":ref:`dev-manual/common-tasks:debugging parallel make races`"
5492 section in the Yocto Project Development Tasks Manual. 5492 section in the Yocto Project Development Tasks Manual.
5493 5493
5494 :term:`PATCHRESOLVE` 5494 :term:`PATCHRESOLVE`
@@ -5580,7 +5580,7 @@ system and gives an overview of their function and contents.
5580 For examples of how this data is used, see the 5580 For examples of how this data is used, see the
5581 ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" 5581 ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`"
5582 section in the Yocto Project Overview and Concepts Manual and the 5582 section in the Yocto Project Overview and Concepts Manual and the
5583 ":ref:`dev-manual/dev-manual-common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" 5583 ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``"
5584 section in the Yocto Project Development Tasks Manual. For more 5584 section in the Yocto Project Development Tasks Manual. For more
5585 information on the shared, global-state directory, see 5585 information on the shared, global-state directory, see
5586 :term:`STAGING_DIR_HOST`. 5586 :term:`STAGING_DIR_HOST`.
@@ -5713,7 +5713,7 @@ system and gives an overview of their function and contents.
5713 5713
5714 Because manually managing ``PR`` can be cumbersome and error-prone, 5714 Because manually managing ``PR`` can be cumbersome and error-prone,
5715 an automated solution exists. See the 5715 an automated solution exists. See the
5716 ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" section 5716 ":ref:`dev-manual/common-tasks:working with a pr service`" section
5717 in the Yocto Project Development Tasks Manual for more information. 5717 in the Yocto Project Development Tasks Manual for more information.
5718 5718
5719 :term:`PREFERRED_PROVIDER` 5719 :term:`PREFERRED_PROVIDER`
@@ -5738,7 +5738,7 @@ system and gives an overview of their function and contents.
5738 PREFERRED_PROVIDER_virtual/libgl ?= "mesa" 5738 PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
5739 5739
5740 For more 5740 For more
5741 information, see the ":ref:`dev-manual/dev-manual-common-tasks:using virtual providers`" 5741 information, see the ":ref:`dev-manual/common-tasks:using virtual providers`"
5742 section in the Yocto Project Development Tasks Manual. 5742 section in the Yocto Project Development Tasks Manual.
5743 5743
5744 .. note:: 5744 .. note::
@@ -5951,7 +5951,7 @@ system and gives an overview of their function and contents.
5951 5951
5952 You must 5952 You must
5953 set the variable if you want to automatically start a local :ref:`PR 5953 set the variable if you want to automatically start a local :ref:`PR
5954 service <dev-manual/dev-manual-common-tasks:working with a pr service>`. You can 5954 service <dev-manual/common-tasks:working with a pr service>`. You can
5955 set ``PRSERV_HOST`` to other values to use a remote PR service. 5955 set ``PRSERV_HOST`` to other values to use a remote PR service.
5956 5956
5957 5957
@@ -5965,7 +5965,7 @@ system and gives an overview of their function and contents.
5965 5965
5966 :term:`PTEST_ENABLED` 5966 :term:`PTEST_ENABLED`
5967 Specifies whether or not :ref:`Package 5967 Specifies whether or not :ref:`Package
5968 Test <dev-manual/dev-manual-common-tasks:testing packages with ptest>` (ptest) 5968 Test <dev-manual/common-tasks:testing packages with ptest>` (ptest)
5969 functionality is enabled when building a recipe. You should not set 5969 functionality is enabled when building a recipe. You should not set
5970 this variable directly. Enabling and disabling building Package Tests 5970 this variable directly. Enabling and disabling building Package Tests
5971 at build time should be done by adding "ptest" to (or removing it 5971 at build time should be done by adding "ptest" to (or removing it
@@ -7000,7 +7000,7 @@ system and gives an overview of their function and contents.
7000 various ``SPL_*`` variables used by the OpenEmbedded build system. 7000 various ``SPL_*`` variables used by the OpenEmbedded build system.
7001 7001
7002 See the BeagleBone machine configuration example in the 7002 See the BeagleBone machine configuration example in the
7003 ":ref:`dev-manual/dev-manual-common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" 7003 ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`"
7004 section in the Yocto Project Board Support Package Developer's Guide 7004 section in the Yocto Project Board Support Package Developer's Guide
7005 for additional information. 7005 for additional information.
7006 7006
@@ -7200,7 +7200,7 @@ system and gives an overview of their function and contents.
7200 For information on limitations when inheriting the latest revision 7200 For information on limitations when inheriting the latest revision
7201 of software using ``SRCREV``, see the :term:`AUTOREV` variable 7201 of software using ``SRCREV``, see the :term:`AUTOREV` variable
7202 description and the 7202 description and the
7203 ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" 7203 ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`"
7204 section, which is in the Yocto Project Development Tasks Manual. 7204 section, which is in the Yocto Project Development Tasks Manual.
7205 7205
7206 :term:`SSTATE_DIR` 7206 :term:`SSTATE_DIR`
@@ -7660,7 +7660,7 @@ system and gives an overview of their function and contents.
7660 7660
7661 :term:`SYSVINIT_ENABLED_GETTYS` 7661 :term:`SYSVINIT_ENABLED_GETTYS`
7662 When using 7662 When using
7663 :ref:`SysVinit <dev-manual/dev-manual-common-tasks:enabling system services>`, 7663 :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`,
7664 specifies a space-separated list of the virtual terminals that should 7664 specifies a space-separated list of the virtual terminals that should
7665 run a `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ 7665 run a `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__
7666 (allowing login), assuming :term:`USE_VT` is not set to 7666 (allowing login), assuming :term:`USE_VT` is not set to
@@ -7946,7 +7946,7 @@ system and gives an overview of their function and contents.
7946 file. 7946 file.
7947 7947
7948 For more information on testing images, see the 7948 For more information on testing images, see the
7949 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 7949 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
7950 section in the Yocto Project Development Tasks Manual. 7950 section in the Yocto Project Development Tasks Manual.
7951 7951
7952 :term:`TEST_SERIALCONTROL_CMD` 7952 :term:`TEST_SERIALCONTROL_CMD`
@@ -8022,7 +8022,7 @@ system and gives an overview of their function and contents.
8022 TEST_SUITES = "test_A test_B" 8022 TEST_SUITES = "test_A test_B"
8023 8023
8024 For more information on testing images, see the 8024 For more information on testing images, see the
8025 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 8025 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
8026 section in the Yocto Project Development Tasks Manual. 8026 section in the Yocto Project Development Tasks Manual.
8027 8027
8028 :term:`TEST_TARGET` 8028 :term:`TEST_TARGET`
@@ -8042,7 +8042,7 @@ system and gives an overview of their function and contents.
8042 You can provide the following arguments with ``TEST_TARGET``: 8042 You can provide the following arguments with ``TEST_TARGET``:
8043 8043
8044 - *"qemu":* Boots a QEMU image and runs the tests. See the 8044 - *"qemu":* Boots a QEMU image and runs the tests. See the
8045 ":ref:`dev-manual/dev-manual-common-tasks:enabling runtime tests on qemu`" section 8045 ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section
8046 in the Yocto Project Development Tasks Manual for more 8046 in the Yocto Project Development Tasks Manual for more
8047 information. 8047 information.
8048 8048
@@ -8058,7 +8058,7 @@ system and gives an overview of their function and contents.
8058 ``meta/lib/oeqa/controllers/simpleremote.py``. 8058 ``meta/lib/oeqa/controllers/simpleremote.py``.
8059 8059
8060 For information on running tests on hardware, see the 8060 For information on running tests on hardware, see the
8061 ":ref:`dev-manual/dev-manual-common-tasks:enabling runtime tests on hardware`" 8061 ":ref:`dev-manual/common-tasks:enabling runtime tests on hardware`"
8062 section in the Yocto Project Development Tasks Manual. 8062 section in the Yocto Project Development Tasks Manual.
8063 8063
8064 :term:`TEST_TARGET_IP` 8064 :term:`TEST_TARGET_IP`
@@ -8096,7 +8096,7 @@ system and gives an overview of their function and contents.
8096 8096
8097 For more information 8097 For more information
8098 on enabling, running, and writing these tests, see the 8098 on enabling, running, and writing these tests, see the
8099 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 8099 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
8100 section in the Yocto Project Development Tasks Manual and the 8100 section in the Yocto Project Development Tasks Manual and the
8101 ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section. 8101 ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section.
8102 8102
@@ -8554,13 +8554,13 @@ system and gives an overview of their function and contents.
8554 specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a 8554 specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a
8555 statically populated ``/dev`` directory. 8555 statically populated ``/dev`` directory.
8556 8556
8557 See the ":ref:`dev-manual/dev-manual-common-tasks:selecting a device manager`" section in 8557 See the ":ref:`dev-manual/common-tasks:selecting a device manager`" section in
8558 the Yocto Project Development Tasks Manual for information on how to 8558 the Yocto Project Development Tasks Manual for information on how to
8559 use this variable. 8559 use this variable.
8560 8560
8561 :term:`USE_VT` 8561 :term:`USE_VT`
8562 When using 8562 When using
8563 :ref:`SysVinit <dev-manual/dev-manual-common-tasks:enabling system services>`, 8563 :ref:`SysVinit <dev-manual/common-tasks:enabling system services>`,
8564 determines whether or not to run a 8564 determines whether or not to run a
8565 `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any 8565 `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any
8566 virtual terminals in order to enable logging in through those 8566 virtual terminals in order to enable logging in through those
@@ -8735,7 +8735,7 @@ system and gives an overview of their function and contents.
8735 OpenEmbedded build system to create a partitioned image 8735 OpenEmbedded build system to create a partitioned image
8736 (image\ ``.wic``). For information on how to create a partitioned 8736 (image\ ``.wic``). For information on how to create a partitioned
8737 image, see the 8737 image, see the
8738 ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" 8738 ":ref:`dev-manual/common-tasks:creating partitioned images using wic`"
8739 section in the Yocto Project Development Tasks Manual. For details on 8739 section in the Yocto Project Development Tasks Manual. For details on
8740 the kickstart file format, see the ":doc:`/ref-manual/ref-kickstart`" Chapter. 8740 the kickstart file format, see the ":doc:`/ref-manual/ref-kickstart`" Chapter.
8741 8741
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index fd04593d43..77c3678095 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -23,7 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes
23to the project either by creating and sending pull requests, or by 23to the project either by creating and sending pull requests, or by
24submitting patches through email. For information on how to do both as 24submitting patches through email. For information on how to do both as
25well as information on how to identify the maintainer for each area of 25well as information on how to identify the maintainer for each area of
26code, see the ":ref:`dev-manual/dev-manual-common-tasks:submitting a change to the yocto project`" section in the 26code, see the ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section in the
27Yocto Project Development Tasks Manual. 27Yocto Project Development Tasks Manual.
28 28
29.. _resources-bugtracker: 29.. _resources-bugtracker:
@@ -47,7 +47,7 @@ A general procedure and guidelines exist for when you use Bugzilla to
47submit a bug. For information on how to use Bugzilla to submit a bug 47submit a bug. For information on how to use Bugzilla to submit a bug
48against the Yocto Project, see the following: 48against the Yocto Project, see the following:
49 49
50- The ":ref:`dev-manual/dev-manual-common-tasks:submitting a defect against the yocto project`" 50- The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`"
51 section in the Yocto Project Development Tasks Manual. 51 section in the Yocto Project Development Tasks Manual.
52 52
53- The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` 53- The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.rst b/documentation/sdk-manual/sdk-appendix-obtain.rst
index 6b7128c27b..8d4fe09646 100644
--- a/documentation/sdk-manual/sdk-appendix-obtain.rst
+++ b/documentation/sdk-manual/sdk-appendix-obtain.rst
@@ -81,7 +81,7 @@ As an alternative to locating and downloading an SDK installer, you can
81build the SDK installer. Follow these steps: 81build the SDK installer. Follow these steps:
82 82
831. *Set Up the Build Environment:* Be sure you are set up to use BitBake 831. *Set Up the Build Environment:* Be sure you are set up to use BitBake
84 in a shell. See the ":ref:`dev-manual/dev-manual-start:preparing the build host`" section 84 in a shell. See the ":ref:`dev-manual/start:preparing the build host`" section
85 in the Yocto Project Development Tasks Manual for information on how 85 in the Yocto Project Development Tasks Manual for information on how
86 to get a build host ready that is either a native Linux machine or a 86 to get a build host ready that is either a native Linux machine or a
87 machine that uses CROPS. 87 machine that uses CROPS.
@@ -89,9 +89,9 @@ build the SDK installer. Follow these steps:
892. *Clone the ``poky`` Repository:* You need to have a local copy of the 892. *Clone the ``poky`` Repository:* You need to have a local copy of the
90 Yocto Project :term:`Source Directory` 90 Yocto Project :term:`Source Directory`
91 (i.e. a local 91 (i.e. a local
92 ``poky`` repository). See the ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" and 92 ``poky`` repository). See the ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" and
93 possibly the ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" and 93 possibly the ":ref:`dev-manual/start:checking out by branch in poky`" and
94 ":ref:`dev-manual/dev-manual-start:checking out by tag in poky`" sections 94 ":ref:`dev-manual/start:checking out by tag in poky`" sections
95 all in the Yocto Project Development Tasks Manual for information on 95 all in the Yocto Project Development Tasks Manual for information on
96 how to clone the ``poky`` repository and check out the appropriate 96 how to clone the ``poky`` repository and check out the appropriate
97 branch for your work. 97 branch for your work.
diff --git a/documentation/sdk-manual/sdk-intro.rst b/documentation/sdk-manual/sdk-intro.rst
index 5514c6767a..66b12cdff9 100644
--- a/documentation/sdk-manual/sdk-intro.rst
+++ b/documentation/sdk-manual/sdk-intro.rst
@@ -211,7 +211,7 @@ You just need to follow these general steps:
211 tools to develop your application. If you need to separately install 211 tools to develop your application. If you need to separately install
212 and use the QEMU emulator, you can go to `QEMU Home 212 and use the QEMU emulator, you can go to `QEMU Home
213 Page <http://wiki.qemu.org/Main_Page>`__ to download and learn about 213 Page <http://wiki.qemu.org/Main_Page>`__ to download and learn about
214 the emulator. See the ":doc:`/dev-manual/dev-manual-qemu`" chapter in the 214 the emulator. See the ":doc:`/dev-manual/qemu`" chapter in the
215 Yocto Project Development Tasks Manual for information on using QEMU 215 Yocto Project Development Tasks Manual for information on using QEMU
216 within the Yocto Project. 216 within the Yocto Project.
217 217
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst
index 6168ad7700..3dc64bcd4e 100644
--- a/documentation/test-manual/intro.rst
+++ b/documentation/test-manual/intro.rst
@@ -142,7 +142,7 @@ thefollowing types of tests:
142- *Package Testing:* A Package Test (ptest) runs tests against packages 142- *Package Testing:* A Package Test (ptest) runs tests against packages
143 built by the OpenEmbedded build system on the target machine. See the 143 built by the OpenEmbedded build system on the target machine. See the
144 :ref:`Testing Packages With 144 :ref:`Testing Packages With
145 ptest <dev-manual/dev-manual-common-tasks:Testing Packages With ptest>` section 145 ptest <dev-manual/common-tasks:Testing Packages With ptest>` section
146 in the Yocto Project Development Tasks Manual and the 146 in the Yocto Project Development Tasks Manual and the
147 ":yocto_wiki:`Ptest </Ptest>`" Wiki page for more 147 ":yocto_wiki:`Ptest </Ptest>`" Wiki page for more
148 information on Ptest. 148 information on Ptest.
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
index c3f0fef0a2..4da415d860 100644
--- a/documentation/toaster-manual/reference.rst
+++ b/documentation/toaster-manual/reference.rst
@@ -67,7 +67,7 @@ layers.
67For general information on layers, see the 67For general information on layers, see the
68":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`" 68":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`"
69section in the Yocto Project Overview and Concepts Manual. For information on how 69section in the Yocto Project Overview and Concepts Manual. For information on how
70to create layers, see the ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 70to create layers, see the ":ref:`dev-manual/common-tasks:understanding and creating layers`"
71section in the Yocto Project Development Tasks Manual. 71section in the Yocto Project Development Tasks Manual.
72 72
73Configuring Toaster to Hook Into Your Layer Index 73Configuring Toaster to Hook Into Your Layer Index
diff --git a/documentation/toaster-manual/start.rst b/documentation/toaster-manual/start.rst
index 8883374164..c687a82531 100644
--- a/documentation/toaster-manual/start.rst
+++ b/documentation/toaster-manual/start.rst
@@ -14,7 +14,7 @@ Setting Up the Basic System Requirements
14 14
15Before you can use Toaster, you need to first set up your build system 15Before you can use Toaster, you need to first set up your build system
16to run the Yocto Project. To do this, follow the instructions in the 16to run the Yocto Project. To do this, follow the instructions in the
17":ref:`dev-manual/dev-manual-start:preparing the build host`" section of 17":ref:`dev-manual/start:preparing the build host`" section of
18the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might 18the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might
19also need to do an additional install of pip3. :: 19also need to do an additional install of pip3. ::
20 20
diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst
index 3663f53364..997f599f54 100644
--- a/documentation/transitioning-to-a-custom-environment.rst
+++ b/documentation/transitioning-to-a-custom-environment.rst
@@ -42,7 +42,7 @@ Transitioning to a custom environment for systems development
42 You might want to start with the build specification that Poky provides 42 You might want to start with the build specification that Poky provides
43 (which is reference embedded distribution) and then add your newly chosen 43 (which is reference embedded distribution) and then add your newly chosen
44 layers to that. Here is the information :ref:`about adding layers 44 layers to that. Here is the information :ref:`about adding layers
45 <dev-manual/dev-manual-common-tasks:Understanding and Creating Layers>`. 45 <dev-manual/common-tasks:Understanding and Creating Layers>`.
46 46
47#. **Based on the layers you've chosen, make needed changes in your 47#. **Based on the layers you've chosen, make needed changes in your
48 configuration**. 48 configuration**.
@@ -58,7 +58,7 @@ Transitioning to a custom environment for systems development
58 releases. If you are using a Yocto Project release earlier than 2.4, use the 58 releases. If you are using a Yocto Project release earlier than 2.4, use the
59 ``yocto-layer create`` tool. The ``bitbake-layers`` tool also provides a number 59 ``yocto-layer create`` tool. The ``bitbake-layers`` tool also provides a number
60 of other useful layer-related commands. See 60 of other useful layer-related commands. See
61 :ref:`dev-manual/dev-manual-common-tasks:creating a general layer using the 61 :ref:`dev-manual/common-tasks:creating a general layer using the
62 \`\`bitbake-layers\`\` script` section. 62 \`\`bitbake-layers\`\` script` section.
63 63
64#. **Create your own layer for the BSP you're going to use**. 64#. **Create your own layer for the BSP you're going to use**.
@@ -79,7 +79,7 @@ Transitioning to a custom environment for systems development
79 process of refinement. Start by getting each step of the build process 79 process of refinement. Start by getting each step of the build process
80 working beginning with fetching all the way through packaging. Next, run the 80 working beginning with fetching all the way through packaging. Next, run the
81 software on your target and refine further as needed. See :ref:`Writing a New 81 software on your target and refine further as needed. See :ref:`Writing a New
82 Recipe <dev-manual/dev-manual-common-tasks:writing a new recipe>` in the 82 Recipe <dev-manual/common-tasks:writing a new recipe>` in the
83 Yocto Project Development Tasks Manual for more information. 83 Yocto Project Development Tasks Manual for more information.
84 84
85#. **Now you're ready to create an image recipe**. 85#. **Now you're ready to create an image recipe**.
@@ -103,7 +103,7 @@ Transitioning to a custom environment for systems development
103 needs to change for your distribution. If you find yourself adding a lot of 103 needs to change for your distribution. If you find yourself adding a lot of
104 configuration to your local.conf file aside from paths and other typical 104 configuration to your local.conf file aside from paths and other typical
105 local settings, it's time to :ref:`consider creating your own distribution 105 local settings, it's time to :ref:`consider creating your own distribution
106 <dev-manual/dev-manual-common-tasks:creating your own distribution>`. 106 <dev-manual/common-tasks:creating your own distribution>`.
107 107
108 You can add product specifications that can customize the distribution if 108 You can add product specifications that can customize the distribution if
109 needed in other layers. You can also add other functionality specific to the 109 needed in other layers. You can also add other functionality specific to the
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst
index 563594b523..a8902c0bec 100644
--- a/documentation/what-i-wish-id-known.rst
+++ b/documentation/what-i-wish-id-known.rst
@@ -132,7 +132,7 @@ contact us with other suggestions.
132 say "bitbake foo" where "foo" is the name for a specific recipe. As you 132 say "bitbake foo" where "foo" is the name for a specific recipe. As you
133 become more advanced using the Yocto Project, and if builds are failing, it 133 become more advanced using the Yocto Project, and if builds are failing, it
134 can be useful to make sure the fetch itself works as desired. Here are some 134 can be useful to make sure the fetch itself works as desired. Here are some
135 valuable links: :ref:`dev-manual/dev-manual-common-tasks:Using a Development 135 valuable links: :ref:`dev-manual/common-tasks:Using a Development
136 Shell` for information on how to build and run a specific task using 136 Shell` for information on how to build and run a specific task using
137 devshell. Also, the :ref:`SDK manual shows how to build out a specific recipe 137 devshell. Also, the :ref:`SDK manual shows how to build out a specific recipe
138 <sdk-manual/sdk-extensible:use \`\`devtool modify\`\` to modify the source of an existing component>`. 138 <sdk-manual/sdk-extensible:use \`\`devtool modify\`\` to modify the source of an existing component>`.