diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:35 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | 097d0c9f04353866302efebcdd0b497c2b89cabb (patch) | |
tree | 305ac5b0776eb37623a9be99a81bee3434a5e4a9 /documentation | |
parent | bd1789261122c25d62b8e8e7f7d5647249e8d8ff (diff) | |
download | poky-097d0c9f04353866302efebcdd0b497c2b89cabb.tar.gz |
sphinx: use absolute paths for :doc: references
:doc: references can be made with absolute path instead of relative
path. This patch was generated with this command:
sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst
And a few manual fixup we made for references such as:
:doc:"FOOBAR <../xxx>"
Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
23 files changed, 79 insertions, 79 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index e8912f07ca..c1b78d0f59 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
@@ -39,7 +39,7 @@ build a reference embedded OS called Poky. | |||
39 | Tasks Manual for more information. | 39 | Tasks Manual for more information. |
40 | 40 | ||
41 | If you want more conceptual or background information on the Yocto | 41 | If you want more conceptual or background information on the Yocto |
42 | Project, see the :doc:`../overview-manual/index`. | 42 | Project, see the :doc:`/overview-manual/index`. |
43 | 43 | ||
44 | Compatible Linux Distribution | 44 | Compatible Linux Distribution |
45 | ============================= | 45 | ============================= |
@@ -404,7 +404,7 @@ information including the website, wiki pages, and user manuals: | |||
404 | concepts are useful for the beginner. | 404 | concepts are useful for the beginner. |
405 | 405 | ||
406 | - **Yocto Project Overview and Concepts Manual:** The | 406 | - **Yocto Project Overview and Concepts Manual:** The |
407 | :doc:`../overview-manual/index` is a great | 407 | :doc:`/overview-manual/index` is a great |
408 | place to start to learn about the Yocto Project. This manual | 408 | place to start to learn about the Yocto Project. This manual |
409 | introduces you to the Yocto Project and its development environment. | 409 | introduces you to the Yocto Project and its development environment. |
410 | The manual also provides conceptual information for various aspects | 410 | The manual also provides conceptual information for various aspects |
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst index e22bcd50ec..0a2e6d9df3 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.rst +++ b/documentation/dev-manual/dev-manual-common-tasks.rst | |||
@@ -1319,7 +1319,7 @@ to determine how well the build went. | |||
1319 | ``log.do_fetch``, and ``log.do_compile``). | 1319 | ``log.do_fetch``, and ``log.do_compile``). |
1320 | 1320 | ||
1321 | You can find more information about the build process in | 1321 | You can find more information about the build process in |
1322 | ":doc:`../overview-manual/overview-manual-development-environment`" | 1322 | ":doc:`/overview-manual/overview-manual-development-environment`" |
1323 | chapter of the Yocto Project Overview and Concepts Manual. | 1323 | chapter of the Yocto Project Overview and Concepts Manual. |
1324 | 1324 | ||
1325 | Fetching Code | 1325 | Fetching Code |
@@ -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/ref-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/sdk-extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" | 3132 | ":ref:`sdk-manual/sdk-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 |
@@ -3644,7 +3644,7 @@ build host running Linux. | |||
3644 | 3644 | ||
3645 | - For information on how to build an image using | 3645 | - For information on how to build an image using |
3646 | :term:`Toaster`, see the | 3646 | :term:`Toaster`, see the |
3647 | :doc:`../toaster-manual/index`. | 3647 | :doc:`/toaster-manual/index`. |
3648 | 3648 | ||
3649 | - For information on how to use ``devtool`` to build images, see the | 3649 | - For information on how to use ``devtool`` to build images, see the |
3650 | ":ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow`" | 3650 | ":ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow`" |
@@ -3653,7 +3653,7 @@ build host running Linux. | |||
3653 | 3653 | ||
3654 | - For a quick example on how to build an image using the | 3654 | - For a quick example on how to build an image using the |
3655 | OpenEmbedded build system, see the | 3655 | OpenEmbedded build system, see the |
3656 | :doc:`../brief-yoctoprojectqs/index` document. | 3656 | :doc:`/brief-yoctoprojectqs/index` document. |
3657 | 3657 | ||
3658 | The build process creates an entire Linux distribution from source and | 3658 | The build process creates an entire Linux distribution from source and |
3659 | places it in your :term:`Build Directory` under | 3659 | places it in your :term:`Build Directory` under |
@@ -3728,7 +3728,7 @@ The following figure and list overviews the build process: | |||
3728 | kernels built by the OpenEmbedded build system are placed in the | 3728 | kernels built by the OpenEmbedded build system are placed in the |
3729 | Build Directory in ``tmp/deploy/images``. For information on how to | 3729 | Build Directory in ``tmp/deploy/images``. For information on how to |
3730 | run pre-built images such as ``qemux86`` and ``qemuarm``, see the | 3730 | run pre-built images such as ``qemux86`` and ``qemuarm``, see the |
3731 | :doc:`../sdk-manual/index` manual. For | 3731 | :doc:`/sdk-manual/index` manual. For |
3732 | information about how to install these images, see the documentation | 3732 | information about how to install these images, see the documentation |
3733 | for your particular board or machine. | 3733 | for your particular board or machine. |
3734 | 3734 | ||
@@ -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/ref-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/ref-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 |
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst index 94c481b7d8..23c848e870 100644 --- a/documentation/dev-manual/dev-manual-intro.rst +++ b/documentation/dev-manual/dev-manual-intro.rst | |||
@@ -31,13 +31,13 @@ This manual provides the following: | |||
31 | This manual does not provide the following: | 31 | This manual does not provide the following: |
32 | 32 | ||
33 | - Redundant Step-by-step Instructions: For example, the | 33 | - Redundant Step-by-step Instructions: For example, the |
34 | :doc:`../sdk-manual/index` manual contains detailed | 34 | :doc:`/sdk-manual/index` manual contains detailed |
35 | instructions on how to install an SDK, which is used to develop | 35 | instructions on how to install an SDK, which is used to develop |
36 | applications for target hardware. | 36 | applications for target hardware. |
37 | 37 | ||
38 | - Reference or Conceptual Material: This type of material resides in an | 38 | - Reference or Conceptual Material: This type of material resides in an |
39 | appropriate reference manual. For example, system variables are | 39 | appropriate reference manual. For example, system variables are |
40 | documented in the :doc:`../ref-manual/index`. | 40 | documented in the :doc:`/ref-manual/index`. |
41 | 41 | ||
42 | - Detailed Public Information Not Specific to the Yocto Project: For | 42 | - Detailed Public Information Not Specific to the Yocto Project: For |
43 | example, exhaustive information on how to use the Source Control | 43 | example, exhaustive information on how to use the Source Control |
@@ -52,7 +52,7 @@ supplemental information is recommended for full comprehension. For | |||
52 | introductory information on the Yocto Project, see the | 52 | introductory information on the Yocto Project, see the |
53 | :yocto_home:`Yocto Project Website <>`. If you want to build an image with no | 53 | :yocto_home:`Yocto Project Website <>`. If you want to build an image with no |
54 | knowledge of Yocto Project as a way of quickly testing it out, see the | 54 | knowledge of Yocto Project as a way of quickly testing it out, see the |
55 | :doc:`../brief-yoctoprojectqs/index` document. | 55 | :doc:`/brief-yoctoprojectqs/index` document. |
56 | 56 | ||
57 | For a comprehensive list of links and other documentation, see the | 57 | For a comprehensive list of links and other documentation, see the |
58 | ":ref:`ref-manual/resources:links and related documentation`" | 58 | ":ref:`ref-manual/resources:links and related documentation`" |
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst index 053f09cdcd..d4727a6f6f 100644 --- a/documentation/dev-manual/dev-manual-start.rst +++ b/documentation/dev-manual/dev-manual-start.rst | |||
@@ -342,10 +342,10 @@ using a given development path on your native Linux machine. If you are | |||
342 | going to use BitBake, see the | 342 | going to use BitBake, see the |
343 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" | 343 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" |
344 | section. If you are going | 344 | section. If you are going |
345 | to use the Extensible SDK, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto | 345 | to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto |
346 | Project Application Development and the Extensible Software Development | 346 | Project Application Development and the Extensible Software Development |
347 | Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`../kernel-dev/index`. If you are going to use | 347 | Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use |
348 | Toaster, see the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" | 348 | Toaster, see the ":doc:`/toaster-manual/toaster-manual-setup-and-use`" |
349 | section in the Toaster User Manual. | 349 | section in the Toaster User Manual. |
350 | 350 | ||
351 | Setting Up to Use CROss PlatformS (CROPS) | 351 | Setting Up to Use CROss PlatformS (CROPS) |
@@ -442,10 +442,10 @@ as if you were running on a native Linux machine. If you are going to | |||
442 | use the Poky container, see the | 442 | use the Poky container, see the |
443 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" | 443 | ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" |
444 | section. If you are going to use the Extensible SDK container, see the | 444 | section. 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 |
446 | Project Application Development and the Extensible Software Development | 446 | Project Application Development and the Extensible Software Development |
447 | Kit (eSDK) manual. If you are going to use the Toaster container, see | 447 | Kit (eSDK) manual. If you are going to use the Toaster container, see |
448 | the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" | 448 | the ":doc:`/toaster-manual/toaster-manual-setup-and-use`" |
449 | section in the Toaster User Manual. | 449 | section in the Toaster User Manual. |
450 | 450 | ||
451 | Setting Up to Use Windows Subsystem For Linux (WSLv2) | 451 | Setting Up to Use Windows Subsystem For Linux (WSLv2) |
@@ -557,10 +557,10 @@ your Yocto Project build host: | |||
557 | 557 | ||
558 | Once you have WSLv2 set up, everything is in place to develop just as if | 558 | Once you have WSLv2 set up, everything is in place to develop just as if |
559 | you were running on a native Linux machine. If you are going to use the | 559 | you were running on a native Linux machine. If you are going to use the |
560 | Extensible SDK container, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto | 560 | Extensible SDK container, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto |
561 | Project Application Development and the Extensible Software Development | 561 | Project Application Development and the Extensible Software Development |
562 | Kit (eSDK) manual. If you are going to use the Toaster container, see | 562 | Kit (eSDK) manual. If you are going to use the Toaster container, see |
563 | the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" | 563 | the ":doc:`/toaster-manual/toaster-manual-setup-and-use`" |
564 | section in the Toaster User Manual. | 564 | section in the Toaster User Manual. |
565 | 565 | ||
566 | Locating Yocto Project Source Files | 566 | Locating Yocto Project Source Files |
diff --git a/documentation/kernel-dev/kernel-dev-advanced.rst b/documentation/kernel-dev/kernel-dev-advanced.rst index cc48343257..ddb31edca3 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.rst +++ b/documentation/kernel-dev/kernel-dev-advanced.rst | |||
@@ -474,7 +474,7 @@ supported kernel type. | |||
474 | This section overviews the BSP description structure, the aggregation | 474 | This section overviews the BSP description structure, the aggregation |
475 | concepts, and presents a detailed example using a BSP supported by the | 475 | concepts, and presents a detailed example using a BSP supported by the |
476 | Yocto Project (i.e. BeagleBone Board). For complete information on BSP | 476 | Yocto Project (i.e. BeagleBone Board). For complete information on BSP |
477 | layer file hierarchy, see the :doc:`../bsp-guide/index`. | 477 | layer file hierarchy, see the :doc:`/bsp-guide/index`. |
478 | 478 | ||
479 | Description Overview | 479 | Description Overview |
480 | ~~~~~~~~~~~~~~~~~~~~ | 480 | ~~~~~~~~~~~~~~~~~~~~ |
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst index c57025c67c..8e9bc27bf5 100644 --- a/documentation/kernel-dev/kernel-dev-common.rst +++ b/documentation/kernel-dev/kernel-dev-common.rst | |||
@@ -21,7 +21,7 @@ Preparing the Build Host to Work on the Kernel | |||
21 | 21 | ||
22 | Before you can do any kernel development, you need to be sure your build | 22 | Before you can do any kernel development, you need to be sure your build |
23 | host is set up to use the Yocto Project. For information on how to get | 23 | host is set up to use the Yocto Project. For information on how to get |
24 | set up, see the ":doc:`../dev-manual/dev-manual-start`" section in | 24 | set up, see the ":doc:`/dev-manual/dev-manual-start`" section in |
25 | the Yocto Project Development Tasks Manual. Part of preparing the system | 25 | the Yocto Project Development Tasks Manual. Part of preparing the system |
26 | is creating a local Git repository of the | 26 | is 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 |
@@ -502,7 +502,7 @@ your layer in the following area: | |||
502 | .. note:: | 502 | .. note:: |
503 | 503 | ||
504 | If you are working on a new machine Board Support Package (BSP), be | 504 | If you are working on a new machine Board Support Package (BSP), be |
505 | sure to refer to the :doc:`../bsp-guide/index`. | 505 | sure to refer to the :doc:`/bsp-guide/index`. |
506 | 506 | ||
507 | As an example, consider the following append file used by the BSPs in | 507 | As an example, consider the following append file used by the BSPs in |
508 | ``meta-yocto-bsp``: | 508 | ``meta-yocto-bsp``: |
diff --git a/documentation/kernel-dev/kernel-dev-intro.rst b/documentation/kernel-dev/kernel-dev-intro.rst index a2961d864d..29d4516c53 100644 --- a/documentation/kernel-dev/kernel-dev-intro.rst +++ b/documentation/kernel-dev/kernel-dev-intro.rst | |||
@@ -79,9 +79,9 @@ facilitate the process of working with the kernel recipes. If you find | |||
79 | you need some additional background, please be sure to review and | 79 | you need some additional background, please be sure to review and |
80 | understand the following documentation: | 80 | understand the following documentation: |
81 | 81 | ||
82 | - :doc:`../brief-yoctoprojectqs/index` document. | 82 | - :doc:`/brief-yoctoprojectqs/index` document. |
83 | 83 | ||
84 | - :doc:`../overview-manual/index`. | 84 | - :doc:`/overview-manual/index`. |
85 | 85 | ||
86 | - :ref:`devtool | 86 | - :ref:`devtool |
87 | workflow <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>` | 87 | workflow <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>` |
@@ -111,7 +111,7 @@ general information and references for further information. | |||
111 | :align: center | 111 | :align: center |
112 | 112 | ||
113 | 1. *Set up Your Host Development System to Support Development Using the | 113 | 1. *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/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 d79dacbfb8..bbf2d0494e 100644 --- a/documentation/overview-manual/overview-manual-concepts.rst +++ b/documentation/overview-manual/overview-manual-concepts.rst | |||
@@ -481,7 +481,7 @@ The BSP Layer provides machine configurations that target specific | |||
481 | hardware. Everything in this layer is specific to the machine for which | 481 | hardware. Everything in this layer is specific to the machine for which |
482 | you are building the image or the SDK. A common structure or form is | 482 | you are building the image or the SDK. A common structure or form is |
483 | defined for BSP layers. You can learn more about this structure in the | 483 | defined for BSP layers. You can learn more about this structure in the |
484 | :doc:`../bsp-guide/index`. | 484 | :doc:`/bsp-guide/index`. |
485 | 485 | ||
486 | .. note:: | 486 | .. note:: |
487 | 487 | ||
@@ -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/ref-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` |
@@ -1366,7 +1366,7 @@ can initialize the environment before using the tools. | |||
1366 | section. | 1366 | section. |
1367 | 1367 | ||
1368 | - For information on setting up a cross-development environment, see | 1368 | - For information on setting up a cross-development environment, see |
1369 | the :doc:`../sdk-manual/index` manual. | 1369 | the :doc:`/sdk-manual/index` manual. |
1370 | 1370 | ||
1371 | All the output files for an SDK are written to the ``deploy/sdk`` folder | 1371 | All the output files for an SDK are written to the ``deploy/sdk`` folder |
1372 | inside the :term:`Build Directory` as | 1372 | inside the :term:`Build Directory` as |
@@ -1446,7 +1446,7 @@ The Yocto Project does most of the work for you when it comes to | |||
1446 | creating :ref:`sdk-manual/sdk-intro:the cross-development toolchain`. This | 1446 | creating :ref:`sdk-manual/sdk-intro:the cross-development toolchain`. This |
1447 | section provides some technical background on how cross-development | 1447 | section provides some technical background on how cross-development |
1448 | toolchains are created and used. For more information on toolchains, you | 1448 | toolchains are created and used. For more information on toolchains, you |
1449 | can also see the :doc:`../sdk-manual/index` manual. | 1449 | can also see the :doc:`/sdk-manual/index` manual. |
1450 | 1450 | ||
1451 | In the Yocto Project development environment, cross-development | 1451 | In the Yocto Project development environment, cross-development |
1452 | toolchains are used to build images and applications that run on the | 1452 | toolchains are used to build images and applications that run on the |
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst index 36a2462134..2421ec1a85 100644 --- a/documentation/overview-manual/overview-manual-development-environment.rst +++ b/documentation/overview-manual/overview-manual-development-environment.rst | |||
@@ -103,7 +103,7 @@ methods exist for you to do work in the Yocto Project environment: | |||
103 | hardware. To development BSPs, you need to take some additional steps | 103 | hardware. To development BSPs, you need to take some additional steps |
104 | beyond what was described in setting up a development host. | 104 | beyond what was described in setting up a development host. |
105 | 105 | ||
106 | The :doc:`../bsp-guide/index` provides BSP-related development | 106 | The :doc:`/bsp-guide/index` provides BSP-related development |
107 | information. For specifics on development host preparation, see the | 107 | information. For specifics on development host preparation, see the |
108 | ":ref:`bsp-guide/bsp:preparing your build host to work with bsp layers`" | 108 | ":ref:`bsp-guide/bsp:preparing your build host to work with bsp layers`" |
109 | section in the Yocto Project Board Support Package (BSP) Developer's | 109 | section in the Yocto Project Board Support Package (BSP) Developer's |
@@ -114,7 +114,7 @@ methods exist for you to do work in the Yocto Project environment: | |||
114 | using ``devtool`` makes kernel development quicker by reducing | 114 | using ``devtool`` makes kernel development quicker by reducing |
115 | iteration cycle times. | 115 | iteration cycle times. |
116 | 116 | ||
117 | The :doc:`../kernel-dev/index` provides kernel-related | 117 | The :doc:`/kernel-dev/index` provides kernel-related |
118 | development information. For specifics on development host | 118 | development information. For specifics on development host |
119 | preparation, see the | 119 | preparation, see the |
120 | ":ref:`kernel-dev/kernel-dev-common:preparing the build host to work on the kernel`" | 120 | ":ref:`kernel-dev/kernel-dev-common:preparing the build host to work on the kernel`" |
@@ -130,7 +130,7 @@ methods exist for you to do work in the Yocto Project environment: | |||
130 | 130 | ||
131 | For steps that show you how to set up your development host to use | 131 | For steps that show you how to set up your development host to use |
132 | Toaster and on how to use Toaster in general, see the | 132 | Toaster and on how to use Toaster in general, see the |
133 | :doc:`../toaster-manual/index`. | 133 | :doc:`/toaster-manual/index`. |
134 | 134 | ||
135 | Yocto Project Source Repositories | 135 | Yocto Project Source Repositories |
136 | ================================= | 136 | ================================= |
diff --git a/documentation/overview-manual/overview-manual-intro.rst b/documentation/overview-manual/overview-manual-intro.rst index c6fb53ca20..50c623c3b9 100644 --- a/documentation/overview-manual/overview-manual-intro.rst +++ b/documentation/overview-manual/overview-manual-intro.rst | |||
@@ -37,17 +37,17 @@ This manual does not give you the following: | |||
37 | 37 | ||
38 | - *Step-by-step Instructions for Development Tasks:* Instructional | 38 | - *Step-by-step Instructions for Development Tasks:* Instructional |
39 | procedures reside in other manuals within the Yocto Project | 39 | procedures reside in other manuals within the Yocto Project |
40 | documentation set. For example, the :doc:`../dev-manual/index` | 40 | documentation set. For example, the :doc:`/dev-manual/index` |
41 | provides examples on how to perform | 41 | provides examples on how to perform |
42 | various development tasks. As another example, the | 42 | various development tasks. As another example, the |
43 | :doc:`../sdk-manual/index` manual contains detailed | 43 | :doc:`/sdk-manual/index` manual contains detailed |
44 | instructions on how to install an SDK, which is used to develop | 44 | instructions on how to install an SDK, which is used to develop |
45 | applications for target hardware. | 45 | applications for target hardware. |
46 | 46 | ||
47 | - *Reference Material:* This type of material resides in an appropriate | 47 | - *Reference Material:* This type of material resides in an appropriate |
48 | reference manual. For example, system variables are documented in the | 48 | reference manual. For example, system variables are documented in the |
49 | :doc:`../ref-manual/index`. As another | 49 | :doc:`/ref-manual/index`. As another |
50 | example, the :doc:`../bsp-guide/index` contains reference information on | 50 | example, the :doc:`/bsp-guide/index` contains reference information on |
51 | BSPs. | 51 | BSPs. |
52 | 52 | ||
53 | - *Detailed Public Information Not Specific to the Yocto Project:* For | 53 | - *Detailed Public Information Not Specific to the Yocto Project:* For |
@@ -63,7 +63,7 @@ supplemental information is recommended for full comprehension. For | |||
63 | additional introductory information on the Yocto Project, see the | 63 | additional introductory information on the Yocto Project, see the |
64 | :yocto_home:`Yocto Project Website <>`. If you want to build an image | 64 | :yocto_home:`Yocto Project Website <>`. If you want to build an image |
65 | with no knowledge of Yocto Project as a way of quickly testing it out, | 65 | with no knowledge of Yocto Project as a way of quickly testing it out, |
66 | see the :doc:`../brief-yoctoprojectqs/index` document. | 66 | see the :doc:`/brief-yoctoprojectqs/index` document. |
67 | For a comprehensive list of links and other documentation, see the | 67 | For a comprehensive list of links and other documentation, see the |
68 | ":ref:`Links and Related | 68 | ":ref:`Links and Related |
69 | Documentation <resources-links-and-related-documentation>`" | 69 | Documentation <resources-links-and-related-documentation>`" |
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst index bf12a673bb..637d57abb9 100644 --- a/documentation/overview-manual/overview-manual-yp-intro.rst +++ b/documentation/overview-manual/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/ref-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 |
@@ -251,7 +251,7 @@ accomplish this through a recipe that is a BitBake append | |||
251 | .. note:: | 251 | .. note:: |
252 | 252 | ||
253 | For general information on BSP layer structure, see the | 253 | For general information on BSP layer structure, see the |
254 | :doc:`../bsp-guide/index` | 254 | :doc:`/bsp-guide/index` |
255 | . | 255 | . |
256 | 256 | ||
257 | The :term:`Source Directory` | 257 | The :term:`Source Directory` |
@@ -339,12 +339,12 @@ applications using the Yocto Project: | |||
339 | experience supplemented with the powerful set of ``devtool`` commands | 339 | experience supplemented with the powerful set of ``devtool`` commands |
340 | tailored for the Yocto Project environment. | 340 | tailored for the Yocto Project environment. |
341 | 341 | ||
342 | For information on the eSDK, see the :doc:`../sdk-manual/index` Manual. | 342 | For information on the eSDK, see the :doc:`/sdk-manual/index` Manual. |
343 | 343 | ||
344 | - *Toaster:* Toaster is a web interface to the Yocto Project | 344 | - *Toaster:* Toaster is a web interface to the Yocto Project |
345 | OpenEmbedded build system. Toaster allows you to configure, run, and | 345 | OpenEmbedded build system. Toaster allows you to configure, run, and |
346 | view information about builds. For information on Toaster, see the | 346 | view information about builds. For information on Toaster, see the |
347 | :doc:`../toaster-manual/index`. | 347 | :doc:`/toaster-manual/index`. |
348 | 348 | ||
349 | Production Tools | 349 | Production Tools |
350 | ---------------- | 350 | ---------------- |
@@ -392,7 +392,7 @@ activities using the Yocto Project: | |||
392 | benefit of the development community. | 392 | benefit of the development community. |
393 | 393 | ||
394 | You can learn more about the AutoBuilder used by the Yocto Project | 394 | You can learn more about the AutoBuilder used by the Yocto Project |
395 | Autobuilder :doc:`here <../test-manual/test-manual-understand-autobuilder>`. | 395 | Autobuilder :doc:`here </test-manual/test-manual-understand-autobuilder>`. |
396 | 396 | ||
397 | - *Cross-Prelink:* Prelinking is the process of pre-computing the load | 397 | - *Cross-Prelink:* Prelinking is the process of pre-computing the load |
398 | addresses and link tables generated by the dynamic linker as compared | 398 | addresses and link tables generated by the dynamic linker as compared |
@@ -650,7 +650,7 @@ Project. | |||
650 | configure and start builds on multiple remote build servers. | 650 | configure and start builds on multiple remote build servers. |
651 | 651 | ||
652 | For information about and how to use Toaster, see the | 652 | For information about and how to use Toaster, see the |
653 | :doc:`../toaster-manual/index`. | 653 | :doc:`/toaster-manual/index`. |
654 | 654 | ||
655 | Reference Embedded Distribution (Poky) | 655 | Reference Embedded Distribution (Poky) |
656 | ====================================== | 656 | ====================================== |
@@ -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/ref-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/ref-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 | ||
@@ -812,7 +812,7 @@ helpful for getting started: | |||
812 | application developers. This eSDK allows developers to incorporate | 812 | application developers. This eSDK allows developers to incorporate |
813 | their library and programming changes back into the image to make | 813 | their library and programming changes back into the image to make |
814 | their code available to other application developers. For information | 814 | their code available to other application developers. For information |
815 | on the eSDK, see the :doc:`../sdk-manual/index` manual. | 815 | on the eSDK, see the :doc:`/sdk-manual/index` manual. |
816 | 816 | ||
817 | - *Layer:* A collection of related recipes. Layers allow you to | 817 | - *Layer:* A collection of related recipes. Layers allow you to |
818 | consolidate related metadata to customize your build. Layers also | 818 | consolidate related metadata to customize your build. Layers also |
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 747561e061..819b6857d9 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst | |||
@@ -47,7 +47,7 @@ Support Package (BSP) layer for it. For more information on how to | |||
47 | create a BSP layer, see the | 47 | create a BSP layer, see the |
48 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" | 48 | ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" |
49 | section in the Yocto Project Development Tasks Manual and the | 49 | section in the Yocto Project Development Tasks Manual and the |
50 | :doc:`../bsp-guide/index`. | 50 | :doc:`/bsp-guide/index`. |
51 | 51 | ||
52 | Usually, if the board is not completely exotic, adding support in the | 52 | Usually, if the board is not completely exotic, adding support in the |
53 | Yocto Project is fairly straightforward. | 53 | Yocto Project is fairly straightforward. |
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst index 8ea1aa7f0a..25ee21499c 100644 --- a/documentation/ref-manual/migration-2.1.rst +++ b/documentation/ref-manual/migration-2.1.rst | |||
@@ -234,7 +234,7 @@ functionality almost completely overlapped with the :ref:`standard | |||
234 | SDK <sdk-manual/sdk-using:using the standard sdk>` and the | 234 | SDK <sdk-manual/sdk-using:using the standard sdk>` and the |
235 | :ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For | 235 | :ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For |
236 | information on these SDKs and how to build and use them, see the | 236 | information on these SDKs and how to build and use them, see the |
237 | :doc:`../sdk-manual/index` manual. | 237 | :doc:`/sdk-manual/index` manual. |
238 | 238 | ||
239 | .. note:: | 239 | .. note:: |
240 | 240 | ||
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst index a769b3bd40..83861d271c 100644 --- a/documentation/ref-manual/ref-devtool-reference.rst +++ b/documentation/ref-manual/ref-devtool-reference.rst | |||
@@ -11,7 +11,7 @@ is a key part of the extensible SDK. | |||
11 | 11 | ||
12 | This chapter provides a Quick Reference for the ``devtool`` command. For | 12 | This chapter provides a Quick Reference for the ``devtool`` command. For |
13 | more information on how to apply the command when using the extensible | 13 | more information on how to apply the command when using the extensible |
14 | SDK, see the ":doc:`../sdk-manual/sdk-extensible`" chapter in the Yocto | 14 | SDK, see the ":doc:`/sdk-manual/sdk-extensible`" chapter in the Yocto |
15 | Project Application Development and the Extensible Software Development | 15 | Project Application Development and the Extensible Software Development |
16 | Kit (eSDK) manual. | 16 | Kit (eSDK) manual. |
17 | 17 | ||
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst index c9223e4131..6c85c24181 100644 --- a/documentation/ref-manual/ref-features.rst +++ b/documentation/ref-manual/ref-features.rst | |||
@@ -261,7 +261,7 @@ these valid features is as follows: | |||
261 | 261 | ||
262 | - *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and | 262 | - *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and |
263 | ``LTTng``. For general information on user-space tools, see the | 263 | ``LTTng``. For general information on user-space tools, see the |
264 | :doc:`../sdk-manual/index` manual. | 264 | :doc:`/sdk-manual/index` manual. |
265 | 265 | ||
266 | - *ssh-server-dropbear:* Installs the Dropbear minimal SSH server. | 266 | - *ssh-server-dropbear:* Installs the Dropbear minimal SSH server. |
267 | 267 | ||
@@ -275,7 +275,7 @@ these valid features is as follows: | |||
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/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 | ||
280 | - *tools-sdk:* Installs a full SDK that runs on the device. | 280 | - *tools-sdk:* Installs a full SDK that runs on the device. |
281 | 281 | ||
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst index c77a3bcb18..ec6d233877 100644 --- a/documentation/ref-manual/ref-release-process.rst +++ b/documentation/ref-manual/ref-release-process.rst | |||
@@ -128,7 +128,7 @@ 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/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. |
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst index a172a0b71c..d3a231554f 100644 --- a/documentation/ref-manual/ref-structure.rst +++ b/documentation/ref-manual/ref-structure.rst | |||
@@ -104,7 +104,7 @@ metadata to define the Poky reference distribution. | |||
104 | 104 | ||
105 | This directory contains the Yocto Project reference hardware Board | 105 | This directory contains the Yocto Project reference hardware Board |
106 | Support Packages (BSPs). For more information on BSPs, see the | 106 | Support Packages (BSPs). For more information on BSPs, see the |
107 | :doc:`../bsp-guide/index`. | 107 | :doc:`/bsp-guide/index`. |
108 | 108 | ||
109 | .. _structure-meta-selftest: | 109 | .. _structure-meta-selftest: |
110 | 110 | ||
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst index 937cd0c707..2c7c1e0754 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst | |||
@@ -20,9 +20,9 @@ chapter in the Yocto Project Overview and Concepts Manual. | |||
20 | 20 | ||
21 | If you want to use the Yocto Project to quickly build an image without | 21 | If you want to use the Yocto Project to quickly build an image without |
22 | having to understand concepts, work through the | 22 | having to understand concepts, work through the |
23 | :doc:`../brief-yoctoprojectqs/index` document. You can find "how-to" | 23 | :doc:`/brief-yoctoprojectqs/index` document. You can find "how-to" |
24 | information in the :doc:`../dev-manual/index`. You can find Yocto Project overview | 24 | information in the :doc:`/dev-manual/index`. You can find Yocto Project overview |
25 | and conceptual information in the :doc:`../overview-manual/index`. | 25 | and conceptual information in the :doc:`/overview-manual/index`. |
26 | 26 | ||
27 | .. note:: | 27 | .. note:: |
28 | 28 | ||
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index 3c12a2470c..6f0facf728 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst | |||
@@ -380,7 +380,7 @@ universal, the list includes them just in case: | |||
380 | The interface enables you to | 380 | The interface enables you to |
381 | configure and run your builds. Information about builds is collected | 381 | configure and run your builds. Information about builds is collected |
382 | and stored in a database. For information on Toaster, see the | 382 | and stored in a database. For information on Toaster, see the |
383 | :doc:`../toaster-manual/index`. | 383 | :doc:`/toaster-manual/index`. |
384 | 384 | ||
385 | :term:`Upstream` | 385 | :term:`Upstream` |
386 | A reference to source code or repositories that are not | 386 | A reference to source code or repositories that are not |
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index 5a52833e84..8411989b69 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
@@ -2907,7 +2907,7 @@ system and gives an overview of their function and contents. | |||
2907 | ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`" | 2907 | ":ref:`dev-manual/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. |
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/dev-manual-common-tasks:creating partitioned images using wic`" | 2943 | ":ref:`dev-manual/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. |
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 |
@@ -8154,7 +8154,7 @@ system and gives an overview of their function and contents. | |||
8154 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" | 8154 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" |
8155 | section in the Yocto Project Overview and Concepts Manual. For | 8155 | section in the Yocto Project Overview and Concepts Manual. For |
8156 | information on setting up a cross-development environment, see the | 8156 | information on setting up a cross-development environment, see the |
8157 | :doc:`../sdk-manual/index` manual. | 8157 | :doc:`/sdk-manual/index` manual. |
8158 | 8158 | ||
8159 | :term:`TOOLCHAIN_OUTPUTNAME` | 8159 | :term:`TOOLCHAIN_OUTPUTNAME` |
8160 | This variable defines the name used for the toolchain output. The | 8160 | This variable defines the name used for the toolchain output. The |
@@ -8184,7 +8184,7 @@ system and gives an overview of their function and contents. | |||
8184 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" | 8184 | ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" |
8185 | section in the Yocto Project Overview and Concepts Manual. For | 8185 | section in the Yocto Project Overview and Concepts Manual. For |
8186 | information on setting up a cross-development environment, see the | 8186 | information on setting up a cross-development environment, see the |
8187 | :doc:`../sdk-manual/index` manual. | 8187 | :doc:`/sdk-manual/index` manual. |
8188 | 8188 | ||
8189 | :term:`TOPDIR` | 8189 | :term:`TOPDIR` |
8190 | The top-level :term:`Build Directory`. BitBake | 8190 | The top-level :term:`Build Directory`. BitBake |
@@ -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/dev-manual-common-tasks:creating partitioned images using wic`" | 8738 | ":ref:`dev-manual/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 | ||
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/resources.rst b/documentation/ref-manual/resources.rst index e41ce95cf0..fd04593d43 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
@@ -125,33 +125,33 @@ Here is a list of resources you might find helpful: | |||
125 | guide to the BitBake tool. If you want information on BitBake, see | 125 | guide to the BitBake tool. If you want information on BitBake, see |
126 | this manual. | 126 | this manual. |
127 | 127 | ||
128 | - :doc:`../brief-yoctoprojectqs/index` *:* This | 128 | - :doc:`/brief-yoctoprojectqs/index` *:* This |
129 | short document lets you experience building an image using the Yocto | 129 | short document lets you experience building an image using the Yocto |
130 | Project without having to understand any concepts or details. | 130 | Project without having to understand any concepts or details. |
131 | 131 | ||
132 | - :doc:`../overview-manual/index` *:* This manual provides overview | 132 | - :doc:`/overview-manual/index` *:* This manual provides overview |
133 | and conceptual information about the Yocto Project. | 133 | and conceptual information about the Yocto Project. |
134 | 134 | ||
135 | - :doc:`../dev-manual/index` *:* This manual is a "how-to" guide | 135 | - :doc:`/dev-manual/index` *:* This manual is a "how-to" guide |
136 | that presents procedures useful to both application and system | 136 | that presents procedures useful to both application and system |
137 | developers who use the Yocto Project. | 137 | developers who use the Yocto Project. |
138 | 138 | ||
139 | - :doc:`../sdk-manual/index` *manual :* This | 139 | - :doc:`/sdk-manual/index` *manual :* This |
140 | guide provides information that lets you get going with the standard | 140 | guide provides information that lets you get going with the standard |
141 | or extensible SDK. An SDK, with its cross-development toolchains, | 141 | or extensible SDK. An SDK, with its cross-development toolchains, |
142 | allows you to develop projects inside or outside of the Yocto Project | 142 | allows you to develop projects inside or outside of the Yocto Project |
143 | environment. | 143 | environment. |
144 | 144 | ||
145 | - :doc:`../bsp-guide/bsp` *:* This guide defines the structure | 145 | - :doc:`/bsp-guide/bsp` *:* This guide defines the structure |
146 | for BSP components. Having a commonly understood structure encourages | 146 | for BSP components. Having a commonly understood structure encourages |
147 | standardization. | 147 | standardization. |
148 | 148 | ||
149 | - :doc:`../kernel-dev/index` *:* This manual describes | 149 | - :doc:`/kernel-dev/index` *:* This manual describes |
150 | how to work with Linux Yocto kernels as well as provides a bit of | 150 | how to work with Linux Yocto kernels as well as provides a bit of |
151 | conceptual information on the construction of the Yocto Linux kernel | 151 | conceptual information on the construction of the Yocto Linux kernel |
152 | tree. | 152 | tree. |
153 | 153 | ||
154 | - :doc:`../ref-manual/index` *:* This | 154 | - :doc:`/ref-manual/index` *:* This |
155 | manual provides reference material such as variable, task, and class | 155 | manual provides reference material such as variable, task, and class |
156 | descriptions. | 156 | descriptions. |
157 | 157 | ||
@@ -161,11 +161,11 @@ Here is a list of resources you might find helpful: | |||
161 | which you can easily search for phrases and terms used in the Yocto | 161 | which you can easily search for phrases and terms used in the Yocto |
162 | Project documentation set. | 162 | Project documentation set. |
163 | 163 | ||
164 | - :doc:`../profile-manual/index` *:* This manual presents a set of | 164 | - :doc:`/profile-manual/index` *:* This manual presents a set of |
165 | common and generally useful tracing and profiling schemes along with | 165 | common and generally useful tracing and profiling schemes along with |
166 | their applications (as appropriate) to each tool. | 166 | their applications (as appropriate) to each tool. |
167 | 167 | ||
168 | - :doc:`../toaster-manual/index` *:* This manual | 168 | - :doc:`/toaster-manual/index` *:* This manual |
169 | introduces and describes how to set up and use Toaster. Toaster is an | 169 | introduces and describes how to set up and use Toaster. Toaster is an |
170 | Application Programming Interface (API) and web-based interface to | 170 | Application Programming Interface (API) and web-based interface to |
171 | the :term:`OpenEmbedded Build System`, which uses | 171 | the :term:`OpenEmbedded Build System`, which uses |
diff --git a/documentation/sdk-manual/sdk-intro.rst b/documentation/sdk-manual/sdk-intro.rst index bbd33b8a78..5514c6767a 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/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/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index 3f9fdea5fa..563594b523 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst | |||
@@ -190,28 +190,28 @@ contact us with other suggestions. | |||
190 | contains procedural information grouped to help you get set up, work with | 190 | contains procedural information grouped to help you get set up, work with |
191 | layers, customize images, write new recipes, work with libraries, and use | 191 | layers, customize images, write new recipes, work with libraries, and use |
192 | QEMU. The information is task-based and spans the breadth of the Yocto | 192 | QEMU. The information is task-based and spans the breadth of the Yocto |
193 | Project. See the :doc:`../dev-manual/index`. | 193 | Project. See the :doc:`/dev-manual/index`. |
194 | 194 | ||
195 | * **Look Through the Yocto Project Application Development and the Extensible | 195 | * **Look Through the Yocto Project Application Development and the Extensible |
196 | Software Development Kit (eSDK) manual**: This manual describes how to use | 196 | Software Development Kit (eSDK) manual**: This manual describes how to use |
197 | both the standard SDK and the extensible SDK, which are used primarily for | 197 | both the standard SDK and the extensible SDK, which are used primarily for |
198 | application development. The :doc:`../sdk-manual/sdk-extensible` also provides | 198 | application development. The :doc:`/sdk-manual/sdk-extensible` also provides |
199 | example workflows that use devtool. See the section | 199 | example workflows that use devtool. See the section |
200 | :ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow` | 200 | :ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow` |
201 | for more information. | 201 | for more information. |
202 | 202 | ||
203 | * **Learn About Kernel Development**: If you want to see how to work with the | 203 | * **Learn About Kernel Development**: If you want to see how to work with the |
204 | kernel and understand Yocto Linux kernels, see the :doc:`../kernel-dev/index`. | 204 | kernel and understand Yocto Linux kernels, see the :doc:`/kernel-dev/index`. |
205 | This manual provides information on how to patch the kernel, modify kernel | 205 | This manual provides information on how to patch the kernel, modify kernel |
206 | recipes, and configure the kernel. | 206 | recipes, and configure the kernel. |
207 | 207 | ||
208 | * **Learn About Board Support Packages (BSPs)**: If you want to learn about | 208 | * **Learn About Board Support Packages (BSPs)**: If you want to learn about |
209 | BSPs, see the :doc:`../bsp-guide/index`. This manual also provides an | 209 | BSPs, see the :doc:`/bsp-guide/index`. This manual also provides an |
210 | example BSP creation workflow. See the :doc:`../bsp-guide/bsp` section. | 210 | example BSP creation workflow. See the :doc:`/bsp-guide/bsp` section. |
211 | 211 | ||
212 | * **Learn About Toaster**: Toaster is a web interface to the Yocto Project's | 212 | * **Learn About Toaster**: Toaster is a web interface to the Yocto Project's |
213 | OpenEmbedded build system. If you are interested in using this type of | 213 | OpenEmbedded build system. If you are interested in using this type of |
214 | interface to create images, see the :doc:`../toaster-manual/index`. | 214 | interface to create images, see the :doc:`/toaster-manual/index`. |
215 | 215 | ||
216 | * **Have Available the Yocto Project Reference Manual**: Unlike the rest of | 216 | * **Have Available the Yocto Project Reference Manual**: Unlike the rest of |
217 | the Yocto Project manual set, this manual is comprised of material suited | 217 | the Yocto Project manual set, this manual is comprised of material suited |
@@ -219,7 +219,7 @@ contact us with other suggestions. | |||
219 | look at how the pieces of the Yocto Project development environment work | 219 | look at how the pieces of the Yocto Project development environment work |
220 | together, information on various technical details, guidance on migrating | 220 | together, information on various technical details, guidance on migrating |
221 | to a newer Yocto Project release, reference material on the directory | 221 | to a newer Yocto Project release, reference material on the directory |
222 | structure, classes, and tasks. The :doc:`../ref-manual/index` also | 222 | structure, classes, and tasks. The :doc:`/ref-manual/index` also |
223 | contains a fairly comprehensive glossary of variables used within the Yocto | 223 | contains a fairly comprehensive glossary of variables used within the Yocto |
224 | Project. | 224 | Project. |
225 | 225 | ||