mirror of
https://git.yoctoproject.org/poky
synced 2026-05-08 17:19:20 +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
committed by
Richard Purdie
Richard Purdie
parent
d1f0448ca9
commit
bd17892611
@@ -47,7 +47,7 @@ Support Package (BSP) layer for it. For more information on how to
|
||||
create a BSP layer, see the
|
||||
":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`"
|
||||
section in the Yocto Project Development Tasks Manual and the
|
||||
:doc:`../bsp-guide/bsp-guide`.
|
||||
:doc:`../bsp-guide/index`.
|
||||
|
||||
Usually, if the board is not completely exotic, adding support in the
|
||||
Yocto Project is fairly straightforward.
|
||||
|
||||
@@ -234,7 +234,7 @@ functionality almost completely overlapped with the :ref:`standard
|
||||
SDK <sdk-manual/sdk-using:using the standard sdk>` and the
|
||||
:ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For
|
||||
information on these SDKs and how to build and use them, see the
|
||||
:doc:`../sdk-manual/sdk-manual` manual.
|
||||
:doc:`../sdk-manual/index` manual.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@@ -261,7 +261,7 @@ these valid features is as follows:
|
||||
|
||||
- *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and
|
||||
``LTTng``. For general information on user-space tools, see the
|
||||
:doc:`../sdk-manual/sdk-manual` manual.
|
||||
:doc:`../sdk-manual/index` manual.
|
||||
|
||||
- *ssh-server-dropbear:* Installs the Dropbear minimal SSH server.
|
||||
|
||||
@@ -275,7 +275,7 @@ these valid features is as follows:
|
||||
``gdb``. For information on GDB, see the
|
||||
":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section
|
||||
in the Yocto Project Development Tasks Manual. For information on
|
||||
tracing and profiling, see the :doc:`../profile-manual/profile-manual`.
|
||||
tracing and profiling, see the :doc:`../profile-manual/index`.
|
||||
|
||||
- *tools-sdk:* Installs a full SDK that runs on the device.
|
||||
|
||||
|
||||
@@ -104,7 +104,7 @@ metadata to define the Poky reference distribution.
|
||||
|
||||
This directory contains the Yocto Project reference hardware Board
|
||||
Support Packages (BSPs). For more information on BSPs, see the
|
||||
:doc:`../bsp-guide/bsp-guide`.
|
||||
:doc:`../bsp-guide/index`.
|
||||
|
||||
.. _structure-meta-selftest:
|
||||
|
||||
|
||||
@@ -20,9 +20,9 @@ chapter in the Yocto Project Overview and Concepts Manual.
|
||||
|
||||
If you want to use the Yocto Project to quickly build an image without
|
||||
having to understand concepts, work through the
|
||||
:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. You can find "how-to"
|
||||
information in the :doc:`../dev-manual/dev-manual`. You can find Yocto Project overview
|
||||
and conceptual information in the :doc:`../overview-manual/overview-manual`.
|
||||
:doc:`../brief-yoctoprojectqs/index` document. You can find "how-to"
|
||||
information in the :doc:`../dev-manual/index`. You can find Yocto Project overview
|
||||
and conceptual information in the :doc:`../overview-manual/index`.
|
||||
|
||||
.. note::
|
||||
|
||||
|
||||
@@ -58,8 +58,7 @@ universal, the list includes them just in case:
|
||||
:term:`Board Support Package (BSP)`
|
||||
A group of drivers, definitions, and other components that provide support
|
||||
for a specific hardware configuration. For more information on BSPs, see
|
||||
the :ref:`bsp-guide/bsp-guide:Yocto Project Board Support Package
|
||||
Developer's Guide`.
|
||||
the :doc:`/bsp-guide/index`.
|
||||
|
||||
:term:`Build Directory`
|
||||
This term refers to the area used by the OpenEmbedded build system for
|
||||
@@ -164,17 +163,14 @@ universal, the list includes them just in case:
|
||||
":ref:`overview-manual/overview-manual-concepts:Cross-Development
|
||||
Toolchain Generation`" section in the Yocto Project Overview and Concepts
|
||||
Manual. You can also find more information on using the relocatable
|
||||
toolchain in the :ref:`sdk-manual/sdk-manual:Yocto Project Application
|
||||
Development and the Extensible Software Development Kit (eSDK)` manual.
|
||||
toolchain in the :doc:`/sdk-manual/index` manual.
|
||||
|
||||
:term:`Extensible Software Development Kit (eSDK)`
|
||||
A custom SDK for 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 :ref:`sdk-manual/sdk-manual:Yocto
|
||||
Project Application Development and the Extensible Software Development
|
||||
Kit (eSDK)` manual.
|
||||
For information on the eSDK, see the :doc:`/sdk-manual/index` manual.
|
||||
|
||||
:term:`Image`
|
||||
An image is an artifact of the BitBake build process given a collection of
|
||||
@@ -384,7 +380,7 @@ universal, the list includes them just in case:
|
||||
The interface enables you to
|
||||
configure and run your builds. Information about builds is collected
|
||||
and stored in a database. For information on Toaster, see the
|
||||
:doc:`../toaster-manual/toaster-manual`.
|
||||
:doc:`../toaster-manual/index`.
|
||||
|
||||
:term:`Upstream`
|
||||
A reference to source code or repositories that are not
|
||||
|
||||
@@ -8154,7 +8154,7 @@ system and gives an overview of their function and contents.
|
||||
":ref:`sdk-manual/sdk-intro:the cross-development toolchain`"
|
||||
section in the Yocto Project Overview and Concepts Manual. For
|
||||
information on setting up a cross-development environment, see the
|
||||
:doc:`../sdk-manual/sdk-manual` manual.
|
||||
:doc:`../sdk-manual/index` manual.
|
||||
|
||||
:term:`TOOLCHAIN_OUTPUTNAME`
|
||||
This variable defines the name used for the toolchain output. The
|
||||
@@ -8184,7 +8184,7 @@ system and gives an overview of their function and contents.
|
||||
":ref:`sdk-manual/sdk-intro:the cross-development toolchain`"
|
||||
section in the Yocto Project Overview and Concepts Manual. For
|
||||
information on setting up a cross-development environment, see the
|
||||
:doc:`../sdk-manual/sdk-manual` manual.
|
||||
:doc:`../sdk-manual/index` manual.
|
||||
|
||||
:term:`TOPDIR`
|
||||
The top-level :term:`Build Directory`. BitBake
|
||||
|
||||
@@ -125,18 +125,18 @@ Here is a list of resources you might find helpful:
|
||||
guide to the BitBake tool. If you want information on BitBake, see
|
||||
this manual.
|
||||
|
||||
- :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` *:* This
|
||||
- :doc:`../brief-yoctoprojectqs/index` *:* This
|
||||
short document lets you experience building an image using the Yocto
|
||||
Project without having to understand any concepts or details.
|
||||
|
||||
- :doc:`../overview-manual/overview-manual` *:* This manual provides overview
|
||||
- :doc:`../overview-manual/index` *:* This manual provides overview
|
||||
and conceptual information about the Yocto Project.
|
||||
|
||||
- :doc:`../dev-manual/dev-manual` *:* This manual is a "how-to" guide
|
||||
- :doc:`../dev-manual/index` *:* This manual is a "how-to" guide
|
||||
that presents procedures useful to both application and system
|
||||
developers who use the Yocto Project.
|
||||
|
||||
- :doc:`../sdk-manual/sdk-manual` *manual :* This
|
||||
- :doc:`../sdk-manual/index` *manual :* This
|
||||
guide provides information that lets you get going with the standard
|
||||
or extensible SDK. An SDK, with its cross-development toolchains,
|
||||
allows you to develop projects inside or outside of the Yocto Project
|
||||
@@ -146,12 +146,12 @@ Here is a list of resources you might find helpful:
|
||||
for BSP components. Having a commonly understood structure encourages
|
||||
standardization.
|
||||
|
||||
- :doc:`../kernel-dev/kernel-dev` *:* This manual describes
|
||||
- :doc:`../kernel-dev/index` *:* This manual describes
|
||||
how to work with Linux Yocto kernels as well as provides a bit of
|
||||
conceptual information on the construction of the Yocto Linux kernel
|
||||
tree.
|
||||
|
||||
- :doc:`../ref-manual/ref-manual` *:* This
|
||||
- :doc:`../ref-manual/index` *:* This
|
||||
manual provides reference material such as variable, task, and class
|
||||
descriptions.
|
||||
|
||||
@@ -161,11 +161,11 @@ Here is a list of resources you might find helpful:
|
||||
which you can easily search for phrases and terms used in the Yocto
|
||||
Project documentation set.
|
||||
|
||||
- :doc:`../profile-manual/profile-manual` *:* This manual presents a set of
|
||||
- :doc:`../profile-manual/index` *:* This manual presents a set of
|
||||
common and generally useful tracing and profiling schemes along with
|
||||
their applications (as appropriate) to each tool.
|
||||
|
||||
- :doc:`../toaster-manual/toaster-manual` *:* This manual
|
||||
- :doc:`../toaster-manual/index` *:* This manual
|
||||
introduces and describes how to set up and use Toaster. Toaster is an
|
||||
Application Programming Interface (API) and web-based interface to
|
||||
the :term:`OpenEmbedded Build System`, which uses
|
||||
|
||||
Reference in New Issue
Block a user