From bd1789261122c25d62b8e8e7f7d5647249e8d8ff Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 3 Dec 2020 22:38:34 +0100 Subject: 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 Signed-off-by: Richard Purdie --- documentation/kernel-dev/index.rst | 21 +++++++++++++++++++++ documentation/kernel-dev/kernel-dev-advanced.rst | 2 +- documentation/kernel-dev/kernel-dev-common.rst | 2 +- documentation/kernel-dev/kernel-dev-intro.rst | 4 ++-- documentation/kernel-dev/kernel-dev.rst | 21 --------------------- 5 files changed, 25 insertions(+), 25 deletions(-) create mode 100644 documentation/kernel-dev/index.rst delete mode 100644 documentation/kernel-dev/kernel-dev.rst (limited to 'documentation/kernel-dev') diff --git a/documentation/kernel-dev/index.rst b/documentation/kernel-dev/index.rst new file mode 100644 index 0000000000..55b42ed992 --- /dev/null +++ b/documentation/kernel-dev/index.rst @@ -0,0 +1,21 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +============================================= +Yocto Project Linux Kernel Development Manual +============================================= + +| + +.. toctree:: + :caption: Table of Contents + :numbered: + + kernel-dev-intro + kernel-dev-common + kernel-dev-advanced + kernel-dev-concepts-appx + kernel-dev-maint-appx + kernel-dev-faq + history + +.. include:: /boilerplate.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. This section overviews the BSP description structure, the aggregation concepts, and presents a detailed example using a BSP supported by the Yocto Project (i.e. BeagleBone Board). For complete information on BSP -layer file hierarchy, see the :doc:`../bsp-guide/bsp-guide`. +layer file hierarchy, see the :doc:`../bsp-guide/index`. Description Overview ~~~~~~~~~~~~~~~~~~~~ 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: .. note:: If you are working on a new machine Board Support Package (BSP), be - sure to refer to the :doc:`../bsp-guide/bsp-guide`. + sure to refer to the :doc:`../bsp-guide/index`. As an example, consider the following append file used by the BSPs in ``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 you need some additional background, please be sure to review and understand the following documentation: -- :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. +- :doc:`../brief-yoctoprojectqs/index` document. -- :doc:`../overview-manual/overview-manual`. +- :doc:`../overview-manual/index`. - :ref:`devtool workflow ` diff --git a/documentation/kernel-dev/kernel-dev.rst b/documentation/kernel-dev/kernel-dev.rst deleted file mode 100644 index 55b42ed992..0000000000 --- a/documentation/kernel-dev/kernel-dev.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -============================================= -Yocto Project Linux Kernel Development Manual -============================================= - -| - -.. toctree:: - :caption: Table of Contents - :numbered: - - kernel-dev-intro - kernel-dev-common - kernel-dev-advanced - kernel-dev-concepts-appx - kernel-dev-maint-appx - kernel-dev-faq - history - -.. include:: /boilerplate.rst -- cgit v1.2.3-54-g00ecf