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/kernel-dev | |
| 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/kernel-dev')
| -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.rst | 2 | ||||
| -rw-r--r-- | documentation/kernel-dev/kernel-dev-common.rst | 2 | ||||
| -rw-r--r-- | documentation/kernel-dev/kernel-dev-intro.rst | 4 |
4 files changed, 4 insertions, 4 deletions
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. | |||
| 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/bsp-guide`. | 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 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 | ||
| 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 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 | |||
| 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/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>` |