1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-31 12:49:46 +00:00

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>
This commit is contained in:
Nicolas Dechesne
2020-12-03 22:38:34 +01:00
committed by Richard Purdie
parent d1f0448ca9
commit bd17892611
31 changed files with 69 additions and 73 deletions
@@ -481,7 +481,7 @@ The BSP Layer provides machine configurations that target specific
hardware. Everything in this layer is specific to the machine for which
you are building the image or the SDK. A common structure or form is
defined for BSP layers. You can learn more about this structure in the
:doc:`../bsp-guide/bsp-guide`.
:doc:`../bsp-guide/index`.
.. note::
@@ -1366,7 +1366,7 @@ can initialize the environment before using the tools.
section.
- For information on setting up a cross-development environment, see
the :doc:`../sdk-manual/sdk-manual` manual.
the :doc:`../sdk-manual/index` manual.
All the output files for an SDK are written to the ``deploy/sdk`` folder
inside the :term:`Build Directory` as
@@ -1446,7 +1446,7 @@ The Yocto Project does most of the work for you when it comes to
creating :ref:`sdk-manual/sdk-intro:the cross-development toolchain`. This
section provides some technical background on how cross-development
toolchains are created and used. For more information on toolchains, you
can also see the :doc:`../sdk-manual/sdk-manual` manual.
can also see the :doc:`../sdk-manual/index` manual.
In the Yocto Project development environment, cross-development
toolchains are used to build images and applications that run on the
@@ -103,7 +103,7 @@ methods exist for you to do work in the Yocto Project environment:
hardware. To development BSPs, you need to take some additional steps
beyond what was described in setting up a development host.
The :doc:`../bsp-guide/bsp-guide` provides BSP-related development
The :doc:`../bsp-guide/index` provides BSP-related development
information. For specifics on development host preparation, see the
":ref:`bsp-guide/bsp:preparing your build host to work with bsp layers`"
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:
using ``devtool`` makes kernel development quicker by reducing
iteration cycle times.
The :doc:`../kernel-dev/kernel-dev` provides kernel-related
The :doc:`../kernel-dev/index` provides kernel-related
development information. For specifics on development host
preparation, see the
":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:
For steps that show you how to set up your development host to use
Toaster and on how to use Toaster in general, see the
:doc:`../toaster-manual/toaster-manual`.
:doc:`../toaster-manual/index`.
Yocto Project Source Repositories
=================================
@@ -37,17 +37,17 @@ This manual does not give you the following:
- *Step-by-step Instructions for Development Tasks:* Instructional
procedures reside in other manuals within the Yocto Project
documentation set. For example, the :doc:`../dev-manual/dev-manual`
documentation set. For example, the :doc:`../dev-manual/index`
provides examples on how to perform
various development tasks. As another example, the
:doc:`../sdk-manual/sdk-manual` manual contains detailed
:doc:`../sdk-manual/index` manual contains detailed
instructions on how to install an SDK, which is used to develop
applications for target hardware.
- *Reference Material:* This type of material resides in an appropriate
reference manual. For example, system variables are documented in the
:doc:`../ref-manual/ref-manual`. As another
example, the :doc:`../bsp-guide/bsp-guide` contains reference information on
:doc:`../ref-manual/index`. As another
example, the :doc:`../bsp-guide/index` contains reference information on
BSPs.
- *Detailed Public Information Not Specific to the Yocto Project:* For
@@ -63,7 +63,7 @@ supplemental information is recommended for full comprehension. For
additional introductory information on the Yocto Project, see the
:yocto_home:`Yocto Project Website <>`. If you want to build an image
with no knowledge of Yocto Project as a way of quickly testing it out,
see the :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document.
see the :doc:`../brief-yoctoprojectqs/index` document.
For a comprehensive list of links and other documentation, see the
":ref:`Links and Related
Documentation <resources-links-and-related-documentation>`"
@@ -251,7 +251,7 @@ accomplish this through a recipe that is a BitBake append
.. note::
For general information on BSP layer structure, see the
:doc:`../bsp-guide/bsp-guide`
:doc:`../bsp-guide/index`
.
The :term:`Source Directory`
@@ -339,12 +339,12 @@ applications using the Yocto Project:
experience supplemented with the powerful set of ``devtool`` commands
tailored for the Yocto Project environment.
For information on the eSDK, see the :doc:`../sdk-manual/sdk-manual` Manual.
For information on the eSDK, see the :doc:`../sdk-manual/index` Manual.
- *Toaster:* Toaster is a web interface to the Yocto Project
OpenEmbedded build system. Toaster allows you to configure, run, and
view information about builds. For information on Toaster, see the
:doc:`../toaster-manual/toaster-manual`.
:doc:`../toaster-manual/index`.
Production Tools
----------------
@@ -650,7 +650,7 @@ Project.
configure and start builds on multiple remote build servers.
For information about and how to use Toaster, see the
:doc:`../toaster-manual/toaster-manual`.
:doc:`../toaster-manual/index`.
Reference Embedded Distribution (Poky)
======================================
@@ -812,7 +812,7 @@ helpful for getting started:
application developers. This eSDK allows developers to incorporate
their library and programming changes back into the image to make
their code available to other application developers. For information
on the eSDK, see the :doc:`../sdk-manual/sdk-manual` manual.
on the eSDK, see the :doc:`../sdk-manual/index` manual.
- *Layer:* A collection of related recipes. Layers allow you to
consolidate related metadata to customize your build. Layers also