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/overview-manual/overview-manual-intro.rst | |
| 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/overview-manual/overview-manual-intro.rst')
| -rw-r--r-- | documentation/overview-manual/overview-manual-intro.rst | 10 |
1 files changed, 5 insertions, 5 deletions
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 | |||
| 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/brief-yoctoprojectqs` 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>`" |