diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:34 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | bd1789261122c25d62b8e8e7f7d5647249e8d8ff (patch) | |
tree | 5b831c41d669f37ce42dac9f25a57052fd61119a /documentation/dev-manual | |
parent | d1f0448ca9233fe1a4dc46e6bf86762b31ff34ef (diff) | |
download | poky-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/dev-manual')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.rst | 6 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-intro.rst | 6 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.rst | 2 | ||||
-rw-r--r-- | documentation/dev-manual/index.rst (renamed from documentation/dev-manual/dev-manual.rst) | 0 |
4 files changed, 7 insertions, 7 deletions
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 | ||
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/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: | |||
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/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 | |||
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/brief-yoctoprojectqs` 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 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 | |||
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/kernel-dev`. 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 | ||
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 | |||