summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:34 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commitbd1789261122c25d62b8e8e7f7d5647249e8d8ff (patch)
tree5b831c41d669f37ce42dac9f25a57052fd61119a /documentation
parentd1f0448ca9233fe1a4dc46e6bf86762b31ff34ef (diff)
downloadpoky-bd1789261122c25d62b8e8e7f7d5647249e8d8ff.tar.gz
sphinx: rename top level document in each manual
It is more common to call the top level document index.rst. This is what this patch is doing, along with all required references fixup. (From yocto-docs rev: 2cea7fbba9210479fc0387d7e1b80da9885558f0) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/index.rst (renamed from documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst)4
-rw-r--r--documentation/bsp-guide/index.rst (renamed from documentation/bsp-guide/bsp-guide.rst)0
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst6
-rw-r--r--documentation/dev-manual/dev-manual-intro.rst6
-rw-r--r--documentation/dev-manual/dev-manual-start.rst2
-rw-r--r--documentation/dev-manual/index.rst (renamed from documentation/dev-manual/dev-manual.rst)0
-rw-r--r--documentation/index.rst20
-rw-r--r--documentation/kernel-dev/index.rst (renamed from documentation/kernel-dev/kernel-dev.rst)0
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.rst2
-rw-r--r--documentation/kernel-dev/kernel-dev-common.rst2
-rw-r--r--documentation/kernel-dev/kernel-dev-intro.rst4
-rw-r--r--documentation/overview-manual/index.rst (renamed from documentation/overview-manual/overview-manual.rst)0
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst6
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst6
-rw-r--r--documentation/overview-manual/overview-manual-intro.rst10
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst10
-rw-r--r--documentation/profile-manual/index.rst (renamed from documentation/profile-manual/profile-manual.rst)0
-rw-r--r--documentation/ref-manual/faq.rst2
-rw-r--r--documentation/ref-manual/index.rst (renamed from documentation/ref-manual/ref-manual.rst)0
-rw-r--r--documentation/ref-manual/migration-2.1.rst2
-rw-r--r--documentation/ref-manual/ref-features.rst4
-rw-r--r--documentation/ref-manual/ref-structure.rst2
-rw-r--r--documentation/ref-manual/ref-system-requirements.rst6
-rw-r--r--documentation/ref-manual/ref-terms.rst12
-rw-r--r--documentation/ref-manual/ref-variables.rst4
-rw-r--r--documentation/ref-manual/resources.rst16
-rw-r--r--documentation/sdk-manual/index.rst (renamed from documentation/sdk-manual/sdk-manual.rst)0
-rw-r--r--documentation/test-manual/index.rst (renamed from documentation/test-manual/test-manual.rst)0
-rw-r--r--documentation/toaster-manual/index.rst (renamed from documentation/toaster-manual/toaster-manual.rst)0
-rw-r--r--documentation/transitioning-to-a-custom-environment.rst2
-rw-r--r--documentation/what-i-wish-id-known.rst14
31 files changed, 69 insertions, 73 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/index.rst
index 8772812ebd..e8912f07ca 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.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
41If you want more conceptual or background information on the Yocto 41If you want more conceptual or background information on the Yocto
42Project, see the :doc:`../overview-manual/overview-manual`. 42Project, see the :doc:`../overview-manual/index`.
43 43
44Compatible Linux Distribution 44Compatible 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/overview-manual` 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/bsp-guide/bsp-guide.rst b/documentation/bsp-guide/index.rst
index a4394a85ed..a4394a85ed 100644
--- a/documentation/bsp-guide/bsp-guide.rst
+++ b/documentation/bsp-guide/index.rst
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index 891fd9b001..e22bcd50ec 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -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/toaster-manual`. 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/brief-yoctoprojectqs` document. 3656 :doc:`../brief-yoctoprojectqs/index` document.
3657 3657
3658The build process creates an entire Linux distribution from source and 3658The build process creates an entire Linux distribution from source and
3659places it in your :term:`Build Directory` under 3659places 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/sdk-manual` 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
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst
index 9bbac9610c..94c481b7d8 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:
31This manual does not provide the following: 31This 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/sdk-manual` 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/ref-manual`. 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
52introductory information on the Yocto Project, see the 52introductory 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
54knowledge of Yocto Project as a way of quickly testing it out, see the 54knowledge of Yocto Project as a way of quickly testing it out, see the
55:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. 55:doc:`../brief-yoctoprojectqs/index` document.
56 56
57For a comprehensive list of links and other documentation, see the 57For 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 1c2314c430..053f09cdcd 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/dev-manual-start.rst
@@ -344,7 +344,7 @@ going to use BitBake, see the
344section. If you are going 344section. If you are going
345to use the Extensible SDK, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto 345to use the Extensible SDK, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto
346Project Application Development and the Extensible Software Development 346Project Application Development and the Extensible Software Development
347Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`../kernel-dev/kernel-dev`. If you are going to use 347Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`../kernel-dev/index`. If you are going to use
348Toaster, see the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" 348Toaster, see the ":doc:`../toaster-manual/toaster-manual-setup-and-use`"
349section in the Toaster User Manual. 349section in the Toaster User Manual.
350 350
diff --git a/documentation/dev-manual/dev-manual.rst b/documentation/dev-manual/index.rst
index 8f09224fe8..8f09224fe8 100644
--- a/documentation/dev-manual/dev-manual.rst
+++ b/documentation/dev-manual/index.rst
diff --git a/documentation/index.rst b/documentation/index.rst
index 2891a98621..9f41daf4b4 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -14,7 +14,7 @@ Welcome to the Yocto Project Documentation
14 :maxdepth: 1 14 :maxdepth: 1
15 :caption: Introduction and Overview 15 :caption: Introduction and Overview
16 16
17 Quick Build <brief-yoctoprojectqs/brief-yoctoprojectqs> 17 Quick Build <brief-yoctoprojectqs/index>
18 what-i-wish-id-known 18 what-i-wish-id-known
19 transitioning-to-a-custom-environment 19 transitioning-to-a-custom-environment
20 Yocto Project Software Overview <https://www.yoctoproject.org/software-overview/> 20 Yocto Project Software Overview <https://www.yoctoproject.org/software-overview/>
@@ -25,15 +25,15 @@ Welcome to the Yocto Project Documentation
25 :maxdepth: 1 25 :maxdepth: 1
26 :caption: Manuals 26 :caption: Manuals
27 27
28 Overview and Concepts Manual <overview-manual/overview-manual> 28 Overview and Concepts Manual <overview-manual/index>
29 Reference Manual <ref-manual/ref-manual> 29 Reference Manual <ref-manual/index>
30 Board Support Package (BSP) Developer's guide <bsp-guide/bsp-guide> 30 Board Support Package (BSP) Developer's guide <bsp-guide/index>
31 Development Tasks Manual <dev-manual/dev-manual> 31 Development Tasks Manual <dev-manual/index>
32 Linux Kernel Development Manual <kernel-dev/kernel-dev> 32 Linux Kernel Development Manual <kernel-dev/index>
33 Profile and Tracing Manual <profile-manual/profile-manual> 33 Profile and Tracing Manual <profile-manual/index>
34 Application Development and the Extensible SDK (eSDK) <sdk-manual/sdk-manual> 34 Application Development and the Extensible SDK (eSDK) <sdk-manual/index>
35 Toaster Manual <toaster-manual/toaster-manual> 35 Toaster Manual <toaster-manual/index>
36 Test Environment Manual <test-manual/test-manual> 36 Test Environment Manual <test-manual/index>
37 Bitbake User Manual <https://docs.yoctoproject.org/bitbake> 37 Bitbake User Manual <https://docs.yoctoproject.org/bitbake>
38 38
39.. toctree:: 39.. toctree::
diff --git a/documentation/kernel-dev/kernel-dev.rst b/documentation/kernel-dev/index.rst
index 55b42ed992..55b42ed992 100644
--- a/documentation/kernel-dev/kernel-dev.rst
+++ b/documentation/kernel-dev/index.rst
diff --git a/documentation/kernel-dev/kernel-dev-advanced.rst b/documentation/kernel-dev/kernel-dev-advanced.rst
index db0a1eb2e5..cc48343257 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.rst
+++ b/documentation/kernel-dev/kernel-dev-advanced.rst
@@ -474,7 +474,7 @@ supported kernel type.
474This section overviews the BSP description structure, the aggregation 474This section overviews the BSP description structure, the aggregation
475concepts, and presents a detailed example using a BSP supported by the 475concepts, and presents a detailed example using a BSP supported by the
476Yocto Project (i.e. BeagleBone Board). For complete information on BSP 476Yocto Project (i.e. BeagleBone Board). For complete information on BSP
477layer file hierarchy, see the :doc:`../bsp-guide/bsp-guide`. 477layer file hierarchy, see the :doc:`../bsp-guide/index`.
478 478
479Description Overview 479Description Overview
480~~~~~~~~~~~~~~~~~~~~ 480~~~~~~~~~~~~~~~~~~~~
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst
index 5115f65f40..c57025c67c 100644
--- a/documentation/kernel-dev/kernel-dev-common.rst
+++ b/documentation/kernel-dev/kernel-dev-common.rst
@@ -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/bsp-guide`. 505 sure to refer to the :doc:`../bsp-guide/index`.
506 506
507As an example, consider the following append file used by the BSPs in 507As 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 309c65b4d5..a2961d864d 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
79you need some additional background, please be sure to review and 79you need some additional background, please be sure to review and
80understand the following documentation: 80understand the following documentation:
81 81
82- :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. 82- :doc:`../brief-yoctoprojectqs/index` document.
83 83
84- :doc:`../overview-manual/overview-manual`. 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>`
diff --git a/documentation/overview-manual/overview-manual.rst b/documentation/overview-manual/index.rst
index f20b20e328..f20b20e328 100644
--- a/documentation/overview-manual/overview-manual.rst
+++ b/documentation/overview-manual/index.rst
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst
index 1b522910d2..d79dacbfb8 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
481hardware. Everything in this layer is specific to the machine for which 481hardware. Everything in this layer is specific to the machine for which
482you are building the image or the SDK. A common structure or form is 482you are building the image or the SDK. A common structure or form is
483defined for BSP layers. You can learn more about this structure in the 483defined for BSP layers. You can learn more about this structure in the
484:doc:`../bsp-guide/bsp-guide`. 484:doc:`../bsp-guide/index`.
485 485
486.. note:: 486.. note::
487 487
@@ -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/sdk-manual` manual. 1369 the :doc:`../sdk-manual/index` manual.
1370 1370
1371All the output files for an SDK are written to the ``deploy/sdk`` folder 1371All the output files for an SDK are written to the ``deploy/sdk`` folder
1372inside the :term:`Build Directory` as 1372inside the :term:`Build Directory` as
@@ -1446,7 +1446,7 @@ The Yocto Project does most of the work for you when it comes to
1446creating :ref:`sdk-manual/sdk-intro:the cross-development toolchain`. This 1446creating :ref:`sdk-manual/sdk-intro:the cross-development toolchain`. This
1447section provides some technical background on how cross-development 1447section provides some technical background on how cross-development
1448toolchains are created and used. For more information on toolchains, you 1448toolchains are created and used. For more information on toolchains, you
1449can also see the :doc:`../sdk-manual/sdk-manual` manual. 1449can also see the :doc:`../sdk-manual/index` manual.
1450 1450
1451In the Yocto Project development environment, cross-development 1451In the Yocto Project development environment, cross-development
1452toolchains are used to build images and applications that run on the 1452toolchains 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 5baf08946b..36a2462134 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/bsp-guide` 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/kernel-dev` 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/toaster-manual`. 133 :doc:`../toaster-manual/index`.
134 134
135Yocto Project Source Repositories 135Yocto Project Source Repositories
136================================= 136=================================
diff --git a/documentation/overview-manual/overview-manual-intro.rst b/documentation/overview-manual/overview-manual-intro.rst
index f69824da99..c6fb53ca20 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/dev-manual` 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/sdk-manual` 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/ref-manual`. As another 49 :doc:`../ref-manual/index`. As another
50 example, the :doc:`../bsp-guide/bsp-guide` 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
63additional introductory information on the Yocto Project, see the 63additional 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
65with no knowledge of Yocto Project as a way of quickly testing it out, 65with no knowledge of Yocto Project as a way of quickly testing it out,
66see the :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. 66see the :doc:`../brief-yoctoprojectqs/index` document.
67For a comprehensive list of links and other documentation, see the 67For a comprehensive list of links and other documentation, see the
68":ref:`Links and Related 68":ref:`Links and Related
69Documentation <resources-links-and-related-documentation>`" 69Documentation <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 2b9ea91490..bf12a673bb 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -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/bsp-guide` 254 :doc:`../bsp-guide/index`
255 . 255 .
256 256
257The :term:`Source Directory` 257The :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/sdk-manual` 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/toaster-manual`. 347 :doc:`../toaster-manual/index`.
348 348
349Production Tools 349Production Tools
350---------------- 350----------------
@@ -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/toaster-manual`. 653 :doc:`../toaster-manual/index`.
654 654
655Reference Embedded Distribution (Poky) 655Reference Embedded Distribution (Poky)
656====================================== 656======================================
@@ -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/sdk-manual` 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/profile-manual/profile-manual.rst b/documentation/profile-manual/index.rst
index 5ec5b9e759..5ec5b9e759 100644
--- a/documentation/profile-manual/profile-manual.rst
+++ b/documentation/profile-manual/index.rst
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 3ffc1f2c41..747561e061 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
47create a BSP layer, see the 47create a BSP layer, see the
48":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" 48":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`"
49section in the Yocto Project Development Tasks Manual and the 49section in the Yocto Project Development Tasks Manual and the
50:doc:`../bsp-guide/bsp-guide`. 50:doc:`../bsp-guide/index`.
51 51
52Usually, if the board is not completely exotic, adding support in the 52Usually, if the board is not completely exotic, adding support in the
53Yocto Project is fairly straightforward. 53Yocto Project is fairly straightforward.
diff --git a/documentation/ref-manual/ref-manual.rst b/documentation/ref-manual/index.rst
index 033f4ba28c..033f4ba28c 100644
--- a/documentation/ref-manual/ref-manual.rst
+++ b/documentation/ref-manual/index.rst
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst
index 0220221e01..8ea1aa7f0a 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
234SDK <sdk-manual/sdk-using:using the standard sdk>` and the 234SDK <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
236information on these SDKs and how to build and use them, see the 236information on these SDKs and how to build and use them, see the
237:doc:`../sdk-manual/sdk-manual` manual. 237:doc:`../sdk-manual/index` manual.
238 238
239.. note:: 239.. note::
240 240
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst
index a16460e91c..c9223e4131 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/sdk-manual` 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/profile-manual`. 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-structure.rst b/documentation/ref-manual/ref-structure.rst
index 5d17f0e5c4..a172a0b71c 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
105This directory contains the Yocto Project reference hardware Board 105This directory contains the Yocto Project reference hardware Board
106Support Packages (BSPs). For more information on BSPs, see the 106Support Packages (BSPs). For more information on BSPs, see the
107:doc:`../bsp-guide/bsp-guide`. 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 af8663a5b2..937cd0c707 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
21If you want to use the Yocto Project to quickly build an image without 21If you want to use the Yocto Project to quickly build an image without
22having to understand concepts, work through the 22having to understand concepts, work through the
23:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. You can find "how-to" 23:doc:`../brief-yoctoprojectqs/index` document. You can find "how-to"
24information in the :doc:`../dev-manual/dev-manual`. You can find Yocto Project overview 24information in the :doc:`../dev-manual/index`. You can find Yocto Project overview
25and conceptual information in the :doc:`../overview-manual/overview-manual`. 25and 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 f59aaf2788..3c12a2470c 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -58,8 +58,7 @@ universal, the list includes them just in case:
58 :term:`Board Support Package (BSP)` 58 :term:`Board Support Package (BSP)`
59 A group of drivers, definitions, and other components that provide support 59 A group of drivers, definitions, and other components that provide support
60 for a specific hardware configuration. For more information on BSPs, see 60 for a specific hardware configuration. For more information on BSPs, see
61 the :ref:`bsp-guide/bsp-guide:Yocto Project Board Support Package 61 the :doc:`/bsp-guide/index`.
62 Developer's Guide`.
63 62
64 :term:`Build Directory` 63 :term:`Build Directory`
65 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
@@ -164,17 +163,14 @@ universal, the list includes them just in case:
164 ":ref:`overview-manual/overview-manual-concepts:Cross-Development 163 ":ref:`overview-manual/overview-manual-concepts:Cross-Development
165 Toolchain Generation`" section in the Yocto Project Overview and Concepts 164 Toolchain Generation`" section in the Yocto Project Overview and Concepts
166 Manual. You can also find more information on using the relocatable 165 Manual. You can also find more information on using the relocatable
167 toolchain in the :ref:`sdk-manual/sdk-manual:Yocto Project Application 166 toolchain in the :doc:`/sdk-manual/index` manual.
168 Development and the Extensible Software Development Kit (eSDK)` manual.
169 167
170 :term:`Extensible Software Development Kit (eSDK)` 168 :term:`Extensible Software Development Kit (eSDK)`
171 A custom SDK for application developers. This eSDK allows developers to 169 A custom SDK for application developers. This eSDK allows developers to
172 incorporate their library and programming changes back into the image to 170 incorporate their library and programming changes back into the image to
173 make their code available to other application developers. 171 make their code available to other application developers.
174 172
175 For information on the eSDK, see the :ref:`sdk-manual/sdk-manual:Yocto 173 For information on the eSDK, see the :doc:`/sdk-manual/index` manual.
176 Project Application Development and the Extensible Software Development
177 Kit (eSDK)` manual.
178 174
179 :term:`Image` 175 :term:`Image`
180 An image is an artifact of the BitBake build process given a collection of 176 An image is an artifact of the BitBake build process given a collection of
@@ -384,7 +380,7 @@ universal, the list includes them just in case:
384 The interface enables you to 380 The interface enables you to
385 configure and run your builds. Information about builds is collected 381 configure and run your builds. Information about builds is collected
386 and stored in a database. For information on Toaster, see the 382 and stored in a database. For information on Toaster, see the
387 :doc:`../toaster-manual/toaster-manual`. 383 :doc:`../toaster-manual/index`.
388 384
389 :term:`Upstream` 385 :term:`Upstream`
390 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 f8cd5416d9..5a52833e84 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -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/sdk-manual` 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/sdk-manual` 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
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 70ba8e7be5..e41ce95cf0 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -125,18 +125,18 @@ 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/brief-yoctoprojectqs` *:* 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/overview-manual` *:* 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/dev-manual` *:* 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/sdk-manual` *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
@@ -146,12 +146,12 @@ Here is a list of resources you might find helpful:
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/kernel-dev` *:* 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/ref-manual` *:* 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/profile-manual` *:* 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/toaster-manual` *:* 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-manual.rst b/documentation/sdk-manual/index.rst
index 177826edf3..177826edf3 100644
--- a/documentation/sdk-manual/sdk-manual.rst
+++ b/documentation/sdk-manual/index.rst
diff --git a/documentation/test-manual/test-manual.rst b/documentation/test-manual/index.rst
index 2891f06d81..2891f06d81 100644
--- a/documentation/test-manual/test-manual.rst
+++ b/documentation/test-manual/index.rst
diff --git a/documentation/toaster-manual/toaster-manual.rst b/documentation/toaster-manual/index.rst
index b003f1ceaa..b003f1ceaa 100644
--- a/documentation/toaster-manual/toaster-manual.rst
+++ b/documentation/toaster-manual/index.rst
diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst
index b87fec6893..3663f53364 100644
--- a/documentation/transitioning-to-a-custom-environment.rst
+++ b/documentation/transitioning-to-a-custom-environment.rst
@@ -8,7 +8,7 @@ Transitioning to a custom environment for systems development
8 8
9.. note:: 9.. note::
10 10
11 So you've finished the :doc:`brief-yoctoprojectqs/brief-yoctoprojectqs` and 11 So you've finished the :doc:`brief-yoctoprojectqs/index` and
12 glanced over the document :doc:`what-i-wish-id-known`, the latter contains 12 glanced over the document :doc:`what-i-wish-id-known`, the latter contains
13 important information learned from other users. You're well prepared. But 13 important information learned from other users. You're well prepared. But
14 now, as you are starting your own project, it isn't exactly straightforward what 14 now, as you are starting your own project, it isn't exactly straightforward what
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst
index afc1263829..3f9fdea5fa 100644
--- a/documentation/what-i-wish-id-known.rst
+++ b/documentation/what-i-wish-id-known.rst
@@ -49,7 +49,7 @@ contact us with other suggestions.
49 their silicon. These layers have names such as "meta-intel" or "meta-ti". Try 49 their silicon. These layers have names such as "meta-intel" or "meta-ti". Try
50 not to build layers from scratch. If you do have custom silicon, use one of 50 not to build layers from scratch. If you do have custom silicon, use one of
51 these layers as a guide or template and familiarize yourself with the 51 these layers as a guide or template and familiarize yourself with the
52 :doc:`bsp-guide/bsp-guide`. 52 :doc:`bsp-guide/index`.
53 53
54#. **Do not put everything into one layer:** 54#. **Do not put everything into one layer:**
55 Use different layers to logically separate information in your build. As an 55 Use different layers to logically separate information in your build. As an
@@ -126,7 +126,7 @@ contact us with other suggestions.
126 You can build and run a specific task for a specific package (including 126 You can build and run a specific task for a specific package (including
127 devshell) or even a single recipe. When developers first start using the 127 devshell) or even a single recipe. When developers first start using the
128 Yocto Project, the instructions found in the 128 Yocto Project, the instructions found in the
129 :doc:`brief-yoctoprojectqs/brief-yoctoprojectqs` show how to create an image 129 :doc:`brief-yoctoprojectqs/index` show how to create an image
130 and then run or flash that image. However, you can actually build just a 130 and then run or flash that image. However, you can actually build just a
131 single recipe. Thus, if some dependency or recipe isn't working, you can just 131 single recipe. Thus, if some dependency or recipe isn't working, you can just
132 say "bitbake foo" where "foo" is the name for a specific recipe. As you 132 say "bitbake foo" where "foo" is the name for a specific recipe. As you
@@ -190,7 +190,7 @@ 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/dev-manual`. 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
@@ -201,17 +201,17 @@ contact us with other suggestions.
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/kernel-dev`. 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/bsp-guide`. 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/toaster-manual`. 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/ref-manual` 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