summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
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/overview-manual
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/overview-manual')
-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
5 files changed, 16 insertions, 16 deletions
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