diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 8 | ||||
-rw-r--r-- | documentation/bsp-guide/bsp.rst | 10 | ||||
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 24 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 4 | ||||
-rw-r--r-- | documentation/overview-manual/concepts.rst | 6 | ||||
-rw-r--r-- | documentation/overview-manual/yp-intro.rst | 10 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst (renamed from documentation/ref-manual/ref-classes.rst) | 4 | ||||
-rw-r--r-- | documentation/ref-manual/devtool-reference.rst (renamed from documentation/ref-manual/ref-devtool-reference.rst) | 6 | ||||
-rw-r--r-- | documentation/ref-manual/faq.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/features.rst (renamed from documentation/ref-manual/ref-features.rst) | 0 | ||||
-rw-r--r-- | documentation/ref-manual/images.rst (renamed from documentation/ref-manual/ref-images.rst) | 0 | ||||
-rw-r--r-- | documentation/ref-manual/index.rst | 26 | ||||
-rw-r--r-- | documentation/ref-manual/kickstart.rst (renamed from documentation/ref-manual/ref-kickstart.rst) | 0 | ||||
-rw-r--r-- | documentation/ref-manual/migration-1.5.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/migration-1.6.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/migration-1.7.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/migration-2.1.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/migration-2.3.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/qa-checks.rst (renamed from documentation/ref-manual/ref-qa-checks.rst) | 0 | ||||
-rw-r--r-- | documentation/ref-manual/release-process.rst (renamed from documentation/ref-manual/ref-release-process.rst) | 2 | ||||
-rw-r--r-- | documentation/ref-manual/structure.rst (renamed from documentation/ref-manual/ref-structure.rst) | 2 | ||||
-rw-r--r-- | documentation/ref-manual/system-requirements.rst (renamed from documentation/ref-manual/ref-system-requirements.rst) | 0 | ||||
-rw-r--r-- | documentation/ref-manual/tasks.rst (renamed from documentation/ref-manual/ref-tasks.rst) | 2 | ||||
-rw-r--r-- | documentation/ref-manual/terms.rst (renamed from documentation/ref-manual/ref-terms.rst) | 8 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst (renamed from documentation/ref-manual/ref-variables.rst) | 14 | ||||
-rw-r--r-- | documentation/ref-manual/varlocality.rst (renamed from documentation/ref-manual/ref-varlocality.rst) | 0 | ||||
-rw-r--r-- | documentation/test-manual/intro.rst | 6 |
27 files changed, 73 insertions, 73 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 5dc0bc7924..f077ee843d 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
@@ -52,7 +52,7 @@ following requirements: | |||
52 | - Runs a supported Linux distribution (i.e. recent releases of Fedora, | 52 | - Runs a supported Linux distribution (i.e. recent releases of Fedora, |
53 | openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux | 53 | openSUSE, CentOS, Debian, or Ubuntu). For a list of Linux |
54 | distributions that support the Yocto Project, see the | 54 | distributions that support the Yocto Project, see the |
55 | :ref:`ref-manual/ref-system-requirements:supported linux distributions` | 55 | :ref:`ref-manual/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/start:preparing the build host` | 58 | :ref:`dev-manual/start:preparing the build host` |
@@ -68,7 +68,7 @@ following requirements: | |||
68 | If your build host does not meet any of these three listed version | 68 | If your build host does not meet any of these three listed version |
69 | requirements, you can take steps to prepare the system so that you | 69 | requirements, you can take steps to prepare the system so that you |
70 | can still use the Yocto Project. See the | 70 | can still use the Yocto Project. See the |
71 | :ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions` | 71 | :ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` |
72 | section in the Yocto Project Reference Manual for information. | 72 | section in the Yocto Project Reference Manual for information. |
73 | 73 | ||
74 | Build Host Packages | 74 | Build Host Packages |
@@ -85,7 +85,7 @@ distribution: | |||
85 | .. note:: | 85 | .. note:: |
86 | 86 | ||
87 | For host package requirements on all supported Linux distributions, | 87 | For host package requirements on all supported Linux distributions, |
88 | see the :ref:`ref-manual/ref-system-requirements:required packages for the build host` | 88 | see the :ref:`ref-manual/system-requirements:required packages for the build host` |
89 | section in the Yocto Project Reference Manual. | 89 | section in the Yocto Project Reference Manual. |
90 | 90 | ||
91 | Use Git to Clone Poky | 91 | Use Git to Clone Poky |
@@ -169,7 +169,7 @@ an entire Linux distribution, including the toolchain, from source. | |||
169 | page of the Yocto Project Wiki. | 169 | page of the Yocto Project Wiki. |
170 | 170 | ||
171 | #. **Initialize the Build Environment:** From within the ``poky`` | 171 | #. **Initialize the Build Environment:** From within the ``poky`` |
172 | directory, run the :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\`` | 172 | directory, run the :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` |
173 | environment | 173 | environment |
174 | setup script to define Yocto Project's build environment on your | 174 | setup script to define Yocto Project's build environment on your |
175 | build host. | 175 | build host. |
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 48bff35fa3..068ab6c804 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -81,7 +81,7 @@ directory of that Layer. This directory is what you add to the | |||
81 | ``conf/bblayers.conf`` file found in your | 81 | ``conf/bblayers.conf`` file found in your |
82 | :term:`Build Directory`, which is | 82 | :term:`Build Directory`, which is |
83 | established after you run the OpenEmbedded build environment setup | 83 | established after you run the OpenEmbedded build environment setup |
84 | script (i.e. :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``). | 84 | script (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). |
85 | Adding the root directory allows the :term:`OpenEmbedded Build System` | 85 | Adding the root directory allows the :term:`OpenEmbedded Build System` |
86 | to recognize the BSP | 86 | to recognize the BSP |
87 | layer and from it build an image. Here is an example: :: | 87 | layer and from it build an image. Here is an example: :: |
@@ -229,7 +229,7 @@ section. | |||
229 | 229 | ||
230 | #. *Initialize the Build Environment:* While in the root directory of | 230 | #. *Initialize the Build Environment:* While in the root directory of |
231 | the Source Directory (i.e. ``poky``), run the | 231 | the Source Directory (i.e. ``poky``), run the |
232 | :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\`` environment | 232 | :ref:`ref-manual/structure:\`\`oe-init-build-env\`\`` environment |
233 | setup script to define the OpenEmbedded build environment on your | 233 | setup script to define the OpenEmbedded build environment on your |
234 | build host. :: | 234 | build host. :: |
235 | 235 | ||
@@ -826,7 +826,7 @@ workflow. | |||
826 | 826 | ||
827 | The build process supports several types of images to satisfy | 827 | The build process supports several types of images to satisfy |
828 | different needs. See the | 828 | different needs. See the |
829 | ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto | 829 | ":ref:`ref-manual/images:Images`" chapter in the Yocto |
830 | Project Reference Manual for information on supported images. | 830 | Project Reference Manual for information on supported images. |
831 | 831 | ||
832 | Requirements and Recommendations for Released BSPs | 832 | Requirements and Recommendations for Released BSPs |
@@ -1305,7 +1305,7 @@ the example reference machine configuration file for the BeagleBone | |||
1305 | development boards. Realize that much more can be defined as part of a | 1305 | development boards. Realize that much more can be defined as part of a |
1306 | machine's configuration file. In general, you can learn about related | 1306 | machine's configuration file. In general, you can learn about related |
1307 | variables that this example does not have by locating the variables in | 1307 | variables that this example does not have by locating the variables in |
1308 | the ":ref:`ref-manual/ref-variables:variables glossary`" in the Yocto | 1308 | the ":ref:`ref-manual/variables:variables glossary`" in the Yocto |
1309 | Project Reference Manual. | 1309 | Project Reference Manual. |
1310 | 1310 | ||
1311 | - :term:`PREFERRED_PROVIDER_virtual/xserver <PREFERRED_PROVIDER>`: | 1311 | - :term:`PREFERRED_PROVIDER_virtual/xserver <PREFERRED_PROVIDER>`: |
@@ -1360,7 +1360,7 @@ Project Reference Manual. | |||
1360 | `JFFS2 <https://en.wikipedia.org/wiki/JFFS2>`__ image. | 1360 | `JFFS2 <https://en.wikipedia.org/wiki/JFFS2>`__ image. |
1361 | 1361 | ||
1362 | - :term:`WKS_FILE`: The location of | 1362 | - :term:`WKS_FILE`: The location of |
1363 | the :ref:`Wic kickstart <ref-manual/ref-kickstart:openembedded kickstart (\`\`.wks\`\`) reference>` file used | 1363 | the :ref:`Wic kickstart <ref-manual/kickstart:openembedded kickstart (\`\`.wks\`\`) reference>` file used |
1364 | by the OpenEmbedded build system to create a partitioned image | 1364 | by the OpenEmbedded build system to create a partitioned image |
1365 | (image.wic). | 1365 | (image.wic). |
1366 | 1366 | ||
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 6c4220dd58..ada3bac7e1 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -935,7 +935,7 @@ configures the image you are working with to include | |||
935 | 935 | ||
936 | .. note:: | 936 | .. note:: |
937 | 937 | ||
938 | See the ":ref:`ref-manual/ref-features:image features`" section in the Yocto | 938 | See the ":ref:`ref-manual/features:image features`" section in the Yocto |
939 | Project Reference Manual for a complete list of image features that ship | 939 | Project Reference Manual for a complete list of image features that ship |
940 | with the Yocto Project. | 940 | with the Yocto Project. |
941 | 941 | ||
@@ -1076,7 +1076,7 @@ how to create, write, and test a new recipe. | |||
1076 | 1076 | ||
1077 | For information on variables that are useful for recipes and for | 1077 | For information on variables that are useful for recipes and for |
1078 | information about recipe naming issues, see the | 1078 | information about recipe naming issues, see the |
1079 | ":ref:`ref-manual/ref-varlocality:recipes`" section of the Yocto Project | 1079 | ":ref:`ref-manual/varlocality:recipes`" section of the Yocto Project |
1080 | Reference Manual. | 1080 | Reference Manual. |
1081 | 1081 | ||
1082 | Overview | 1082 | Overview |
@@ -1978,7 +1978,7 @@ take. The following list describes the process: | |||
1978 | of common problems that show up during runtime. For information on | 1978 | of common problems that show up during runtime. For information on |
1979 | these checks, see the | 1979 | these checks, see the |
1980 | :ref:`insane <ref-classes-insane>` class and | 1980 | :ref:`insane <ref-classes-insane>` class and |
1981 | the ":ref:`ref-manual/ref-qa-checks:qa error and warning messages`" | 1981 | the ":ref:`ref-manual/qa-checks:qa error and warning messages`" |
1982 | chapter in the Yocto Project Reference Manual. | 1982 | chapter in the Yocto Project Reference Manual. |
1983 | 1983 | ||
1984 | - *Hand-Checking Your Packages*: After you build your software, you | 1984 | - *Hand-Checking Your Packages*: After you build your software, you |
@@ -3127,7 +3127,7 @@ Using ``devtool upgrade`` | |||
3127 | 3127 | ||
3128 | As mentioned earlier, an alternative method for upgrading recipes to | 3128 | As mentioned earlier, an alternative method for upgrading recipes to |
3129 | newer versions is to use | 3129 | newer versions is to use |
3130 | :doc:`devtool upgrade </ref-manual/ref-devtool-reference>`. | 3130 | :doc:`devtool upgrade </ref-manual/devtool-reference>`. |
3131 | You can read about ``devtool upgrade`` in general in the | 3131 | You can read about ``devtool upgrade`` in general in the |
3132 | ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" | 3132 | ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" |
3133 | section in the Yocto Project Application Development and the Extensible | 3133 | section in the Yocto Project Application Development and the Extensible |
@@ -3714,7 +3714,7 @@ The following figure and list overviews the build process: | |||
3714 | can be the name of a recipe for a specific piece of software such as | 3714 | can be the name of a recipe for a specific piece of software such as |
3715 | BusyBox. For more details about the images the OpenEmbedded build | 3715 | BusyBox. For more details about the images the OpenEmbedded build |
3716 | system supports, see the | 3716 | system supports, see the |
3717 | ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto | 3717 | ":ref:`ref-manual/images:Images`" chapter in the Yocto |
3718 | Project Reference Manual. | 3718 | Project Reference Manual. |
3719 | 3719 | ||
3720 | As an example, the following command builds the | 3720 | As an example, the following command builds the |
@@ -5234,7 +5234,7 @@ particular system. | |||
5234 | .. note:: | 5234 | .. note:: |
5235 | 5235 | ||
5236 | For a kickstart file reference, see the | 5236 | For a kickstart file reference, see the |
5237 | ":ref:`ref-manual/ref-kickstart:openembedded kickstart (\`\`.wks\`\`) reference`" | 5237 | ":ref:`ref-manual/kickstart:openembedded kickstart (\`\`.wks\`\`) reference`" |
5238 | Chapter in the Yocto Project Reference Manual. | 5238 | Chapter in the Yocto Project Reference Manual. |
5239 | 5239 | ||
5240 | The ``wic`` command and the infrastructure it is based on is by | 5240 | The ``wic`` command and the infrastructure it is based on is by |
@@ -7418,7 +7418,7 @@ Creating Node Package Manager (NPM) Packages | |||
7418 | manager for the JavaScript programming language. The Yocto Project | 7418 | manager for the JavaScript programming language. The Yocto Project |
7419 | supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can | 7419 | supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can |
7420 | use this fetcher in combination with | 7420 | use this fetcher in combination with |
7421 | :doc:`devtool </ref-manual/ref-devtool-reference>` to create | 7421 | :doc:`devtool </ref-manual/devtool-reference>` to create |
7422 | recipes that produce NPM packages. | 7422 | recipes that produce NPM packages. |
7423 | 7423 | ||
7424 | Two workflows exist that allow you to create NPM packages using | 7424 | Two workflows exist that allow you to create NPM packages using |
@@ -7446,7 +7446,7 @@ NPM packages: | |||
7446 | is NPM's public registry. | 7446 | is NPM's public registry. |
7447 | 7447 | ||
7448 | - Be familiar with | 7448 | - Be familiar with |
7449 | :doc:`devtool </ref-manual/ref-devtool-reference>`. | 7449 | :doc:`devtool </ref-manual/devtool-reference>`. |
7450 | 7450 | ||
7451 | - The NPM host tools need the native ``nodejs-npm`` package, which is | 7451 | - The NPM host tools need the native ``nodejs-npm`` package, which is |
7452 | part of the OpenEmbedded environment. You need to get the package by | 7452 | part of the OpenEmbedded environment. You need to get the package by |
@@ -8452,7 +8452,7 @@ you set up the environment to use these tests, run available tests, and | |||
8452 | write and add your own tests. | 8452 | write and add your own tests. |
8453 | 8453 | ||
8454 | For information on the test and QA infrastructure available within the | 8454 | For information on the test and QA infrastructure available within the |
8455 | Yocto Project, see the ":ref:`ref-manual/ref-release-process:testing and quality assurance`" | 8455 | Yocto Project, see the ":ref:`ref-manual/release-process:testing and quality assurance`" |
8456 | section in the Yocto Project Reference Manual. | 8456 | section in the Yocto Project Reference Manual. |
8457 | 8457 | ||
8458 | Enabling Tests | 8458 | Enabling Tests |
@@ -9224,7 +9224,7 @@ In addition to variable values, the output of the ``bitbake -e`` and | |||
9224 | - The output starts with a tree listing all configuration files and | 9224 | - The output starts with a tree listing all configuration files and |
9225 | classes included globally, recursively listing the files they include | 9225 | classes included globally, recursively listing the files they include |
9226 | or inherit in turn. Much of the behavior of the OpenEmbedded build | 9226 | or inherit in turn. Much of the behavior of the OpenEmbedded build |
9227 | system (including the behavior of the :ref:`ref-manual/ref-tasks:normal recipe build tasks`) is | 9227 | system (including the behavior of the :ref:`ref-manual/tasks:normal recipe build tasks`) is |
9228 | implemented in the | 9228 | implemented in the |
9229 | :ref:`base <ref-classes-base>` class and the | 9229 | :ref:`base <ref-classes-base>` class and the |
9230 | classes it inherits, rather than being built into BitBake itself. | 9230 | classes it inherits, rather than being built into BitBake itself. |
@@ -9564,7 +9564,7 @@ compile. BitBake recognizes that the ``do_compile`` task was rerun and | |||
9564 | therefore understands that the other tasks also need to be run again. | 9564 | therefore understands that the other tasks also need to be run again. |
9565 | 9565 | ||
9566 | Another, shorter way to rerun a task and all | 9566 | Another, shorter way to rerun a task and all |
9567 | :ref:`ref-manual/ref-tasks:normal recipe build tasks` | 9567 | :ref:`ref-manual/tasks:normal recipe build tasks` |
9568 | that depend on it is to use the ``-C`` option. | 9568 | that depend on it is to use the ``-C`` option. |
9569 | 9569 | ||
9570 | .. note:: | 9570 | .. note:: |
@@ -9998,7 +9998,7 @@ GDB allows you to examine running programs, which in turn helps you to | |||
9998 | understand and fix problems. It also allows you to perform post-mortem | 9998 | understand and fix problems. It also allows you to perform post-mortem |
9999 | style analysis of program crashes. GDB is available as a package within | 9999 | style analysis of program crashes. GDB is available as a package within |
10000 | the Yocto Project and is installed in SDK images by default. See the | 10000 | the Yocto Project and is installed in SDK images by default. See the |
10001 | ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto | 10001 | ":ref:`ref-manual/images:Images`" chapter in the Yocto |
10002 | Project Reference Manual for a description of these images. You can find | 10002 | Project Reference Manual for a description of these images. You can find |
10003 | information on GDB at https://sourceware.org/gdb/. | 10003 | information on GDB at https://sourceware.org/gdb/. |
10004 | 10004 | ||
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 6fad4c9b4c..03061a79f3 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -325,7 +325,7 @@ Project Build Host: | |||
325 | If your build host does not meet any of these three listed version | 325 | If your build host does not meet any of these three listed version |
326 | requirements, you can take steps to prepare the system so that you | 326 | requirements, you can take steps to prepare the system so that you |
327 | can still use the Yocto Project. See the | 327 | can still use the Yocto Project. See the |
328 | ":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`" | 328 | ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" |
329 | section in the Yocto Project Reference Manual for information. | 329 | section in the Yocto Project Reference Manual for information. |
330 | 330 | ||
331 | 4. *Install Development Host Packages:* Required development host | 331 | 4. *Install Development Host Packages:* Required development host |
@@ -334,7 +334,7 @@ Project Build Host: | |||
334 | is large if you want to be able to cover all cases. | 334 | is large if you want to be able to cover all cases. |
335 | 335 | ||
336 | For lists of required packages for all scenarios, see the | 336 | For lists of required packages for all scenarios, see the |
337 | ":ref:`ref-manual/ref-system-requirements:required packages for the build host`" | 337 | ":ref:`ref-manual/system-requirements:required packages for the build host`" |
338 | section in the Yocto Project Reference Manual. | 338 | section in the Yocto Project Reference Manual. |
339 | 339 | ||
340 | Once you have completed the previous steps, you are ready to continue | 340 | Once you have completed the previous steps, you are ready to continue |
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 019ead85cb..8fbbabbac5 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -112,7 +112,7 @@ Class files (``.bbclass``) contain information that is useful to share | |||
112 | between recipes files. An example is the | 112 | between recipes files. An example is the |
113 | :ref:`autotools <ref-classes-autotools>` class, | 113 | :ref:`autotools <ref-classes-autotools>` class, |
114 | which contains common settings for any application that Autotools uses. | 114 | which contains common settings for any application that Autotools uses. |
115 | The ":ref:`ref-manual/ref-classes:Classes`" chapter in the | 115 | The ":ref:`ref-manual/classes:Classes`" chapter in the |
116 | Yocto Project Reference Manual provides details about classes and how to | 116 | Yocto Project Reference Manual provides details about classes and how to |
117 | use them. | 117 | use them. |
118 | 118 | ||
@@ -456,7 +456,7 @@ typically find in the distribution layer: | |||
456 | can be shared among recipes in the distribution. When your recipes | 456 | can be shared among recipes in the distribution. When your recipes |
457 | inherit a class, they take on the settings and functions for that | 457 | inherit a class, they take on the settings and functions for that |
458 | class. You can read more about class files in the | 458 | class. You can read more about class files in the |
459 | ":ref:`ref-manual/ref-classes:Classes`" chapter of the Yocto | 459 | ":ref:`ref-manual/classes:Classes`" chapter of the Yocto |
460 | Reference Manual. | 460 | Reference Manual. |
461 | 461 | ||
462 | - *conf:* This area holds configuration files for the layer | 462 | - *conf:* This area holds configuration files for the layer |
@@ -1285,7 +1285,7 @@ this output: | |||
1285 | .. note:: | 1285 | .. note:: |
1286 | 1286 | ||
1287 | For a list of example images that the Yocto Project provides, see the | 1287 | For a list of example images that the Yocto Project provides, see the |
1288 | ":doc:`/ref-manual/ref-images`" chapter in the Yocto Project Reference | 1288 | ":doc:`/ref-manual/images`" chapter in the Yocto Project Reference |
1289 | Manual. | 1289 | Manual. |
1290 | 1290 | ||
1291 | The build process writes images out to the :term:`Build Directory` | 1291 | The build process writes images out to the :term:`Build Directory` |
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index c66b4b5da2..66a88c9521 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
@@ -111,7 +111,7 @@ Project: | |||
111 | development. | 111 | development. |
112 | 112 | ||
113 | - *Releases According to a Strict Schedule:* Major releases occur on a | 113 | - *Releases According to a Strict Schedule:* Major releases occur on a |
114 | :doc:`six-month cycle </ref-manual/ref-release-process>` | 114 | :doc:`six-month cycle </ref-manual/release-process>` |
115 | predictably in October and April. The most recent two releases | 115 | predictably in October and April. The most recent two releases |
116 | support point releases to address common vulnerabilities and | 116 | support point releases to address common vulnerabilities and |
117 | exposures. This predictability is crucial for projects based on the | 117 | exposures. This predictability is crucial for projects based on the |
@@ -676,7 +676,7 @@ these items that make up the Poky repository in the | |||
676 | 676 | ||
677 | If you are interested in all the contents of the | 677 | If you are interested in all the contents of the |
678 | poky | 678 | poky |
679 | Git repository, see the ":ref:`ref-manual/ref-structure:top-level core components`" | 679 | Git repository, see the ":ref:`ref-manual/structure:top-level core components`" |
680 | section in the Yocto Project Reference Manual. | 680 | section in the Yocto Project Reference Manual. |
681 | 681 | ||
682 | The following figure illustrates what generally comprises Poky: | 682 | The following figure illustrates what generally comprises Poky: |
@@ -720,7 +720,7 @@ Poky has a regular, well established, six-month release cycle under its | |||
720 | own version. Major releases occur at the same time major releases (point | 720 | own version. Major releases occur at the same time major releases (point |
721 | releases) occur for the Yocto Project, which are typically in the Spring | 721 | releases) occur for the Yocto Project, which are typically in the Spring |
722 | and Fall. For more information on the Yocto Project release schedule and | 722 | and Fall. For more information on the Yocto Project release schedule and |
723 | cadence, see the ":doc:`/ref-manual/ref-release-process`" chapter in the | 723 | cadence, see the ":doc:`/ref-manual/release-process`" chapter in the |
724 | Yocto Project Reference Manual. | 724 | Yocto Project Reference Manual. |
725 | 725 | ||
726 | Much has been said about Poky being a "default configuration". A default | 726 | Much has been said about Poky being a "default configuration". A default |
@@ -798,7 +798,7 @@ Some Basic Terms | |||
798 | 798 | ||
799 | It helps to understand some basic fundamental terms when learning the | 799 | It helps to understand some basic fundamental terms when learning the |
800 | Yocto Project. Although a list of terms exists in the ":doc:`Yocto Project | 800 | Yocto Project. Although a list of terms exists in the ":doc:`Yocto Project |
801 | Terms </ref-manual/ref-terms>`" section of the Yocto Project | 801 | Terms </ref-manual/terms>`" section of the Yocto Project |
802 | Reference Manual, this section provides the definitions of some terms | 802 | Reference Manual, this section provides the definitions of some terms |
803 | helpful for getting started: | 803 | helpful for getting started: |
804 | 804 | ||
@@ -879,7 +879,7 @@ helpful for getting started: | |||
879 | 879 | ||
880 | It is worth noting that the term "package" can, in general, have | 880 | It is worth noting that the term "package" can, in general, have |
881 | subtle meanings. For example, the packages referred to in the | 881 | subtle meanings. For example, the packages referred to in the |
882 | ":ref:`ref-manual/ref-system-requirements:required packages for the build host`" | 882 | ":ref:`ref-manual/system-requirements:required packages for the build host`" |
883 | section in the Yocto Project Reference Manual are compiled binaries | 883 | section in the Yocto Project Reference Manual are compiled binaries |
884 | that, when installed, add functionality to your Linux distribution. | 884 | that, when installed, add functionality to your Linux distribution. |
885 | 885 | ||
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/classes.rst index 37ab4992eb..5a30ce379b 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -1033,7 +1033,7 @@ You can configure the sanity checks so that specific test failures | |||
1033 | either raise a warning or an error message. Typically, failures for new | 1033 | either raise a warning or an error message. Typically, failures for new |
1034 | tests generate a warning. Subsequent failures for the same test would | 1034 | tests generate a warning. Subsequent failures for the same test would |
1035 | then generate an error message once the metadata is in a known and good | 1035 | then generate an error message once the metadata is in a known and good |
1036 | condition. See the ":doc:`ref-qa-checks`" Chapter for a list of all the warning | 1036 | condition. See the ":doc:`/ref-manual/qa-checks`" Chapter for a list of all the warning |
1037 | and error messages you might encounter using a default configuration. | 1037 | and error messages you might encounter using a default configuration. |
1038 | 1038 | ||
1039 | Use the :term:`WARN_QA` and | 1039 | Use the :term:`WARN_QA` and |
@@ -1276,7 +1276,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and | |||
1276 | - ``textrel:`` Checks for ELF binaries that contain relocations in | 1276 | - ``textrel:`` Checks for ELF binaries that contain relocations in |
1277 | their ``.text`` sections, which can result in a performance impact at | 1277 | their ``.text`` sections, which can result in a performance impact at |
1278 | runtime. See the explanation for the ``ELF binary`` message in | 1278 | runtime. See the explanation for the ``ELF binary`` message in |
1279 | ":doc:`ref-qa-checks`" for more information regarding runtime performance | 1279 | ":doc:`/ref-manual/qa-checks`" for more information regarding runtime performance |
1280 | issues. | 1280 | issues. |
1281 | 1281 | ||
1282 | - ``unlisted-pkg-lics:`` Checks that all declared licenses applying | 1282 | - ``unlisted-pkg-lics:`` Checks that all declared licenses applying |
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 2b97bb4605..cc5848fd4d 100644 --- a/documentation/ref-manual/ref-devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
@@ -193,7 +193,7 @@ external source tree. | |||
193 | run your application. If dependent packages (e.g. libraries) do not | 193 | run your application. If dependent packages (e.g. libraries) do not |
194 | exist on the target, your application, when run, will fail to find | 194 | exist on the target, your application, when run, will fail to find |
195 | those functions. For more information, see the | 195 | those functions. For more information, see the |
196 | ":ref:`ref-manual/ref-devtool-reference:deploying your software on the target machine`" | 196 | ":ref:`ref-manual/devtool-reference:deploying your software on the target machine`" |
197 | section. | 197 | section. |
198 | 198 | ||
199 | By default, ``devtool add`` uses the latest revision (i.e. master) when | 199 | By default, ``devtool add`` uses the latest revision (i.e. master) when |
@@ -561,7 +561,7 @@ Removing Your Software from the Target Machine | |||
561 | Use the ``devtool undeploy-target`` command to remove deployed build | 561 | Use the ``devtool undeploy-target`` command to remove deployed build |
562 | output from the target machine. For the ``devtool undeploy-target`` | 562 | output from the target machine. For the ``devtool undeploy-target`` |
563 | command to work, you must have previously used the | 563 | command to work, you must have previously used the |
564 | ":ref:`devtool deploy-target <ref-manual/ref-devtool-reference:deploying your software on the target machine>`" | 564 | ":ref:`devtool deploy-target <ref-manual/devtool-reference:deploying your software on the target machine>`" |
565 | command. | 565 | command. |
566 | :: | 566 | :: |
567 | 567 | ||
@@ -609,7 +609,7 @@ The ``devtool status`` command has no command-line options: | |||
609 | $ devtool status | 609 | $ devtool status |
610 | 610 | ||
611 | Following is sample output after using | 611 | Following is sample output after using |
612 | :ref:`devtool add <ref-manual/ref-devtool-reference:adding a new recipe to the workspace layer>` | 612 | :ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>` |
613 | to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory: | 613 | to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory: |
614 | :: | 614 | :: |
615 | 615 | ||
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index cc6b3aee1b..f67c53824b 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
@@ -22,7 +22,7 @@ Can I still use the Yocto Project? | |||
22 | **A:** You can get the required tools on your host development system a | 22 | **A:** You can get the required tools on your host development system a |
23 | couple different ways (i.e. building a tarball or downloading a | 23 | couple different ways (i.e. building a tarball or downloading a |
24 | tarball). See the | 24 | tarball). See the |
25 | ":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`" | 25 | ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" |
26 | section for steps on how to update your build tools. | 26 | section for steps on how to update your build tools. |
27 | 27 | ||
28 | **Q:** How can you claim Poky / OpenEmbedded-Core is stable? | 28 | **Q:** How can you claim Poky / OpenEmbedded-Core is stable? |
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/features.rst index 89c06eb65f..89c06eb65f 100644 --- a/documentation/ref-manual/ref-features.rst +++ b/documentation/ref-manual/features.rst | |||
diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/images.rst index 5e9374eae7..5e9374eae7 100644 --- a/documentation/ref-manual/ref-images.rst +++ b/documentation/ref-manual/images.rst | |||
diff --git a/documentation/ref-manual/index.rst b/documentation/ref-manual/index.rst index 033f4ba28c..deb0383cfc 100644 --- a/documentation/ref-manual/index.rst +++ b/documentation/ref-manual/index.rst | |||
@@ -10,20 +10,20 @@ Yocto Project Reference Manual | |||
10 | :caption: Table of Contents | 10 | :caption: Table of Contents |
11 | :numbered: | 11 | :numbered: |
12 | 12 | ||
13 | ref-system-requirements | 13 | system-requirements |
14 | ref-terms | 14 | terms |
15 | ref-release-process | 15 | release-process |
16 | migration | 16 | migration |
17 | ref-structure | 17 | structure |
18 | ref-classes | 18 | classes |
19 | ref-tasks | 19 | tasks |
20 | ref-devtool-reference | 20 | devtool-reference |
21 | ref-kickstart | 21 | kickstart |
22 | ref-qa-checks | 22 | qa-checks |
23 | ref-images | 23 | images |
24 | ref-features | 24 | features |
25 | ref-variables | 25 | variables |
26 | ref-varlocality | 26 | varlocality |
27 | faq | 27 | faq |
28 | resources | 28 | resources |
29 | history | 29 | history |
diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/kickstart.rst index bb9c0460f3..bb9c0460f3 100644 --- a/documentation/ref-manual/ref-kickstart.rst +++ b/documentation/ref-manual/kickstart.rst | |||
diff --git a/documentation/ref-manual/migration-1.5.rst b/documentation/ref-manual/migration-1.5.rst index b5e4bb1fd1..2716bc9cfd 100644 --- a/documentation/ref-manual/migration-1.5.rst +++ b/documentation/ref-manual/migration-1.5.rst | |||
@@ -26,7 +26,7 @@ provide packages for these, you can install and use the Buildtools | |||
26 | tarball, which provides an SDK-like environment containing them. | 26 | tarball, which provides an SDK-like environment containing them. |
27 | 27 | ||
28 | For more information on this requirement, see the | 28 | For more information on this requirement, see the |
29 | ":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`" | 29 | ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" |
30 | section. | 30 | section. |
31 | 31 | ||
32 | .. _migration-1.5-atom-pc-bsp: | 32 | .. _migration-1.5-atom-pc-bsp: |
diff --git a/documentation/ref-manual/migration-1.6.rst b/documentation/ref-manual/migration-1.6.rst index f95f45ec9f..ed155d0df9 100644 --- a/documentation/ref-manual/migration-1.6.rst +++ b/documentation/ref-manual/migration-1.6.rst | |||
@@ -126,7 +126,7 @@ Changes to Variables | |||
126 | -------------------- | 126 | -------------------- |
127 | 127 | ||
128 | The following variables have changed. For information on the | 128 | The following variables have changed. For information on the |
129 | OpenEmbedded build system variables, see the ":doc:`ref-variables`" Chapter. | 129 | OpenEmbedded build system variables, see the ":doc:`/ref-manual/variables`" Chapter. |
130 | 130 | ||
131 | .. _migration-1.6-variable-changes-TMPDIR: | 131 | .. _migration-1.6-variable-changes-TMPDIR: |
132 | 132 | ||
diff --git a/documentation/ref-manual/migration-1.7.rst b/documentation/ref-manual/migration-1.7.rst index 177d40900f..19275b3cd6 100644 --- a/documentation/ref-manual/migration-1.7.rst +++ b/documentation/ref-manual/migration-1.7.rst | |||
@@ -32,7 +32,7 @@ build host is now 1.7.8 because the ``--list`` option is now required by | |||
32 | BitBake's Git fetcher. As always, if your host distribution does not | 32 | BitBake's Git fetcher. As always, if your host distribution does not |
33 | provide a version of Git that meets this requirement, you can use the | 33 | provide a version of Git that meets this requirement, you can use the |
34 | ``buildtools-tarball`` that does. See the | 34 | ``buildtools-tarball`` that does. See the |
35 | ":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`" | 35 | ":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" |
36 | section for more information. | 36 | section for more information. |
37 | 37 | ||
38 | .. _migration-1.7-autotools-class-changes: | 38 | .. _migration-1.7-autotools-class-changes: |
@@ -157,7 +157,7 @@ The following changes have occurred to the QA check process: | |||
157 | added in order to verify that file dependencies are satisfied (e.g. | 157 | added in order to verify that file dependencies are satisfied (e.g. |
158 | package contains a script requiring ``/bin/bash``) and build-time | 158 | package contains a script requiring ``/bin/bash``) and build-time |
159 | dependencies are declared, respectively. For more information, please | 159 | dependencies are declared, respectively. For more information, please |
160 | see the ":doc:`ref-qa-checks`" chapter. | 160 | see the ":doc:`/ref-manual/qa-checks`" chapter. |
161 | 161 | ||
162 | - Package QA checks are now performed during a new | 162 | - Package QA checks are now performed during a new |
163 | :ref:`ref-tasks-package_qa` task rather than being | 163 | :ref:`ref-tasks-package_qa` task rather than being |
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst index a1d7b9a2da..e8b3ada264 100644 --- a/documentation/ref-manual/migration-2.1.rst +++ b/documentation/ref-manual/migration-2.1.rst | |||
@@ -360,7 +360,7 @@ These additional changes exist: | |||
360 | - The minimum Git version has been increased to 1.8.3.1. If your host | 360 | - The minimum Git version has been increased to 1.8.3.1. If your host |
361 | distribution does not provide a sufficiently recent version, you can | 361 | distribution does not provide a sufficiently recent version, you can |
362 | install the buildtools, which will provide it. See the | 362 | install the buildtools, which will provide it. See the |
363 | :ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions` | 363 | :ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` |
364 | section for more information on the buildtools tarball. | 364 | section for more information on the buildtools tarball. |
365 | 365 | ||
366 | - The buggy and incomplete support for the RPM version 4 package | 366 | - The buggy and incomplete support for the RPM version 4 package |
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst index 6984ff91e8..3e9758119b 100644 --- a/documentation/ref-manual/migration-2.3.rst +++ b/documentation/ref-manual/migration-2.3.rst | |||
@@ -404,7 +404,7 @@ The following QA checks have changed: | |||
404 | 404 | ||
405 | For additional information, see the | 405 | For additional information, see the |
406 | :ref:`insane <ref-classes-insane>` class and the | 406 | :ref:`insane <ref-classes-insane>` class and the |
407 | ":ref:`ref-manual/ref-qa-checks:errors and warnings`" section. | 407 | ":ref:`ref-manual/qa-checks:errors and warnings`" section. |
408 | 408 | ||
409 | .. _migration-2.3-miscellaneous-changes: | 409 | .. _migration-2.3-miscellaneous-changes: |
410 | 410 | ||
diff --git a/documentation/ref-manual/ref-qa-checks.rst b/documentation/ref-manual/qa-checks.rst index 54977dcb21..54977dcb21 100644 --- a/documentation/ref-manual/ref-qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst | |||
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/release-process.rst index 20be09a4ff..d8d362282b 100644 --- a/documentation/ref-manual/ref-release-process.rst +++ b/documentation/ref-manual/release-process.rst | |||
@@ -146,7 +146,7 @@ consists of the following pieces: | |||
146 | .. note:: | 146 | .. note:: |
147 | 147 | ||
148 | Running ``oe-selftest`` requires host packages beyond the "Essential" | 148 | Running ``oe-selftest`` requires host packages beyond the "Essential" |
149 | grouping. See the :ref:`ref-manual/ref-system-requirements:required packages for the build host` | 149 | grouping. See the :ref:`ref-manual/system-requirements:required packages for the build host` |
150 | section for more information. | 150 | section for more information. |
151 | 151 | ||
152 | Originally, much of this testing was done manually. However, significant | 152 | Originally, much of this testing was done manually. However, significant |
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/structure.rst index ab9075b9c5..ad3f4ab44a 100644 --- a/documentation/ref-manual/ref-structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -682,7 +682,7 @@ generation or packaging also have their specific class files such as | |||
682 | ``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``. | 682 | ``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``. |
683 | 683 | ||
684 | For reference information on classes, see the | 684 | For reference information on classes, see the |
685 | ":ref:`ref-manual/ref-classes:Classes`" chapter. | 685 | ":ref:`ref-manual/classes:Classes`" chapter. |
686 | 686 | ||
687 | .. _structure-meta-conf: | 687 | .. _structure-meta-conf: |
688 | 688 | ||
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/system-requirements.rst index 66afb08102..66afb08102 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/tasks.rst index 8b9e0c2d89..9fe1c296aa 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
@@ -461,7 +461,7 @@ devtool commands: | |||
461 | $ devtool latest-version | 461 | $ devtool latest-version |
462 | $ devtool check-upgrade-status | 462 | $ devtool check-upgrade-status |
463 | 463 | ||
464 | See the ":ref:`ref-manual/ref-devtool-reference:\`\`devtool\`\` quick reference`" | 464 | See the ":ref:`ref-manual/devtool-reference:\`\`devtool\`\` quick reference`" |
465 | chapter for more information on | 465 | chapter for more information on |
466 | ``devtool``. See the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" | 466 | ``devtool``. See the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" |
467 | section for information on checking the upgrade status of a recipe. | 467 | section for information on checking the upgrade status of a recipe. |
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/terms.rst index f41073602d..c07dd4b128 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/terms.rst | |||
@@ -64,7 +64,7 @@ universal, the list includes them just in case: | |||
64 | This term refers to the area used by the OpenEmbedded build system for | 64 | This term refers to the area used by the OpenEmbedded build system for |
65 | builds. The area is created when you ``source`` the setup environment | 65 | builds. The area is created when you ``source`` the setup environment |
66 | script that is found in the Source Directory | 66 | script that is found in the Source Directory |
67 | (i.e. :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``). The | 67 | (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The |
68 | :term:`TOPDIR` variable points to the Build Directory. | 68 | :term:`TOPDIR` variable points to the Build Directory. |
69 | 69 | ||
70 | You have a lot of flexibility when creating the Build Directory. | 70 | You have a lot of flexibility when creating the Build Directory. |
@@ -117,7 +117,7 @@ universal, the list includes them just in case: | |||
117 | Files that provide for logic encapsulation and inheritance so that | 117 | Files that provide for logic encapsulation and inheritance so that |
118 | commonly used patterns can be defined once and then easily used in | 118 | commonly used patterns can be defined once and then easily used in |
119 | multiple recipes. For reference information on the Yocto Project classes, | 119 | multiple recipes. For reference information on the Yocto Project classes, |
120 | see the ":ref:`ref-manual/ref-classes:Classes`" chapter. Class files end with the | 120 | see the ":ref:`ref-manual/classes:Classes`" chapter. Class files end with the |
121 | ``.bbclass`` filename extension. | 121 | ``.bbclass`` filename extension. |
122 | 122 | ||
123 | :term:`Configuration File` | 123 | :term:`Configuration File` |
@@ -177,7 +177,7 @@ universal, the list includes them just in case: | |||
177 | recipes and related Metadata. Images are the binary output that run on | 177 | recipes and related Metadata. Images are the binary output that run on |
178 | specific hardware or QEMU and are used for specific use-cases. For a list | 178 | specific hardware or QEMU and are used for specific use-cases. For a list |
179 | of the supported image types that the Yocto Project provides, see the | 179 | of the supported image types that the Yocto Project provides, see the |
180 | ":ref:`ref-manual/ref-images:Images`" chapter. | 180 | ":ref:`ref-manual/images:Images`" chapter. |
181 | 181 | ||
182 | :term:`Layer` | 182 | :term:`Layer` |
183 | A collection of related recipes. Layers allow you to consolidate related | 183 | A collection of related recipes. Layers allow you to consolidate related |
@@ -252,7 +252,7 @@ universal, the list includes them just in case: | |||
252 | 252 | ||
253 | It is worth noting that the term "package" can, in general, have | 253 | It is worth noting that the term "package" can, in general, have |
254 | subtle meanings. For example, the packages referred to in the | 254 | subtle meanings. For example, the packages referred to in the |
255 | ":ref:`ref-manual/ref-system-requirements:required packages for the build host`" | 255 | ":ref:`ref-manual/system-requirements:required packages for the build host`" |
256 | section are compiled binaries that, when installed, add functionality to | 256 | section are compiled binaries that, when installed, add functionality to |
257 | your Linux distribution. | 257 | your Linux distribution. |
258 | 258 | ||
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/variables.rst index 865d17c1fc..8c6cc46b6c 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -1670,7 +1670,7 @@ system and gives an overview of their function and contents. | |||
1670 | ``${TMPDIR}/deploy``. | 1670 | ``${TMPDIR}/deploy``. |
1671 | 1671 | ||
1672 | For more information on the structure of the Build Directory, see | 1672 | For more information on the structure of the Build Directory, see |
1673 | ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. | 1673 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. |
1674 | For more detail on the contents of the ``deploy`` directory, see the | 1674 | For more detail on the contents of the ``deploy`` directory, see the |
1675 | ":ref:`overview-manual/concepts:images`", | 1675 | ":ref:`overview-manual/concepts:images`", |
1676 | ":ref:`overview-manual/concepts:package feeds`", and | 1676 | ":ref:`overview-manual/concepts:package feeds`", and |
@@ -1708,7 +1708,7 @@ system and gives an overview of their function and contents. | |||
1708 | ``${DEPLOY_DIR}/images/${MACHINE}/``. | 1708 | ``${DEPLOY_DIR}/images/${MACHINE}/``. |
1709 | 1709 | ||
1710 | For more information on the structure of the Build Directory, see | 1710 | For more information on the structure of the Build Directory, see |
1711 | ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. | 1711 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. |
1712 | For more detail on the contents of the ``deploy`` directory, see the | 1712 | For more detail on the contents of the ``deploy`` directory, see the |
1713 | ":ref:`overview-manual/concepts:images`" and | 1713 | ":ref:`overview-manual/concepts:images`" and |
1714 | ":ref:`overview-manual/concepts:application development sdk`" sections both in | 1714 | ":ref:`overview-manual/concepts:application development sdk`" sections both in |
@@ -2907,7 +2907,7 @@ system and gives an overview of their function and contents. | |||
2907 | ":ref:`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/kickstart`" chapter. |
2911 | 2911 | ||
2912 | :term:`IMAGE_BOOT_FILES` | 2912 | :term:`IMAGE_BOOT_FILES` |
2913 | A space-separated list of files installed into the boot partition | 2913 | A space-separated list of files installed into the boot partition |
@@ -2943,7 +2943,7 @@ system and gives an overview of their function and contents. | |||
2943 | ":ref:`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/kickstart`" chapter. |
2947 | 2947 | ||
2948 | :term:`IMAGE_CLASSES` | 2948 | :term:`IMAGE_CLASSES` |
2949 | A list of classes that all images should inherit. You typically use | 2949 | A list of classes that all images should inherit. You typically use |
@@ -3051,7 +3051,7 @@ system and gives an overview of their function and contents. | |||
3051 | .. note:: | 3051 | .. note:: |
3052 | 3052 | ||
3053 | - When working with a | 3053 | - When working with a |
3054 | :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>` | 3054 | :ref:`core-image-minimal-initramfs <ref-manual/images:images>` |
3055 | image, do not use the ``IMAGE_INSTALL`` variable to specify | 3055 | image, do not use the ``IMAGE_INSTALL`` variable to specify |
3056 | packages for installation. Instead, use the | 3056 | packages for installation. Instead, use the |
3057 | :term:`PACKAGE_INSTALL` variable, which | 3057 | :term:`PACKAGE_INSTALL` variable, which |
@@ -5240,7 +5240,7 @@ system and gives an overview of their function and contents. | |||
5240 | general, you should use the | 5240 | general, you should use the |
5241 | :term:`IMAGE_INSTALL` variable to specify | 5241 | :term:`IMAGE_INSTALL` variable to specify |
5242 | packages for installation. The exception to this is when working with | 5242 | packages for installation. The exception to this is when working with |
5243 | the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>` | 5243 | the :ref:`core-image-minimal-initramfs <ref-manual/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/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 |
@@ -8737,7 +8737,7 @@ system and gives an overview of their function and contents. | |||
8737 | image, see the | 8737 | image, see the |
8738 | ":ref:`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/kickstart`" Chapter. |
8741 | 8741 | ||
8742 | :term:`WKS_FILE_DEPENDS` | 8742 | :term:`WKS_FILE_DEPENDS` |
8743 | When placed in the recipe that builds your image, this variable lists | 8743 | When placed in the recipe that builds your image, this variable lists |
diff --git a/documentation/ref-manual/ref-varlocality.rst b/documentation/ref-manual/varlocality.rst index 5f7dba8775..5f7dba8775 100644 --- a/documentation/ref-manual/ref-varlocality.rst +++ b/documentation/ref-manual/varlocality.rst | |||
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 3dc64bcd4e..81c24a8c3f 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst | |||
@@ -124,7 +124,7 @@ thefollowing types of tests: | |||
124 | The tests utilize the ``testsdkext`` class and the ``do_testsdkext`` task. | 124 | The tests utilize the ``testsdkext`` class and the ``do_testsdkext`` task. |
125 | 125 | ||
126 | - *Feature Testing:* Various scenario-based tests are run through the | 126 | - *Feature Testing:* Various scenario-based tests are run through the |
127 | :ref:`OpenEmbedded Self test (oe-selftest) <ref-manual/ref-release-process:Testing and Quality Assurance>`. We test oe-selftest on each of the main distrubutions | 127 | :ref:`OpenEmbedded Self test (oe-selftest) <ref-manual/release-process:Testing and Quality Assurance>`. We test oe-selftest on each of the main distrubutions |
128 | we support. | 128 | we support. |
129 | 129 | ||
130 | - *Image Testing:* Image tests initiated through the following command:: | 130 | - *Image Testing:* Image tests initiated through the following command:: |
@@ -155,8 +155,8 @@ thefollowing types of tests: | |||
155 | the ``do_testsdk`` task. | 155 | the ``do_testsdk`` task. |
156 | 156 | ||
157 | - *Unit Testing:* Unit tests on various components of the system run | 157 | - *Unit Testing:* Unit tests on various components of the system run |
158 | through :ref:`bitbake-selftest <ref-manual/ref-release-process:Testing and Quality Assurance>` and | 158 | through :ref:`bitbake-selftest <ref-manual/release-process:Testing and Quality Assurance>` and |
159 | :ref:`oe-selftest <ref-manual/ref-release-process:Testing and Quality Assurance>`. | 159 | :ref:`oe-selftest <ref-manual/release-process:Testing and Quality Assurance>`. |
160 | 160 | ||
161 | - *Automatic Upgrade Helper:* This target tests whether new versions of | 161 | - *Automatic Upgrade Helper:* This target tests whether new versions of |
162 | software are available and whether we can automatically upgrade to | 162 | software are available and whether we can automatically upgrade to |