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

View File

@@ -39,7 +39,7 @@ build a reference embedded OS called Poky.
Tasks Manual for more information. Tasks Manual for more information.
If you want more conceptual or background information on the Yocto If you want more conceptual or background information on the Yocto
Project, see the :doc:`../overview-manual/overview-manual`. Project, see the :doc:`../overview-manual/index`.
Compatible Linux Distribution Compatible Linux Distribution
============================= =============================
@@ -404,7 +404,7 @@ information including the website, wiki pages, and user manuals:
concepts are useful for the beginner. concepts are useful for the beginner.
- **Yocto Project Overview and Concepts Manual:** The - **Yocto Project Overview and Concepts Manual:** The
:doc:`../overview-manual/overview-manual` is a great :doc:`../overview-manual/index` is a great
place to start to learn about the Yocto Project. This manual place to start to learn about the Yocto Project. This manual
introduces you to the Yocto Project and its development environment. introduces you to the Yocto Project and its development environment.
The manual also provides conceptual information for various aspects The manual also provides conceptual information for various aspects

View File

@@ -3644,7 +3644,7 @@ build host running Linux.
- For information on how to build an image using - For information on how to build an image using
:term:`Toaster`, see the :term:`Toaster`, see the
:doc:`../toaster-manual/toaster-manual`. :doc:`../toaster-manual/index`.
- For information on how to use ``devtool`` to build images, see the - For information on how to use ``devtool`` to build images, see the
":ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow`" ":ref:`sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow`"
@@ -3653,7 +3653,7 @@ build host running Linux.
- For a quick example on how to build an image using the - For a quick example on how to build an image using the
OpenEmbedded build system, see the OpenEmbedded build system, see the
:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. :doc:`../brief-yoctoprojectqs/index` document.
The build process creates an entire Linux distribution from source and The build process creates an entire Linux distribution from source and
places it in your :term:`Build Directory` under places it in your :term:`Build Directory` under
@@ -3728,7 +3728,7 @@ The following figure and list overviews the build process:
kernels built by the OpenEmbedded build system are placed in the kernels built by the OpenEmbedded build system are placed in the
Build Directory in ``tmp/deploy/images``. For information on how to Build Directory in ``tmp/deploy/images``. For information on how to
run pre-built images such as ``qemux86`` and ``qemuarm``, see the run pre-built images such as ``qemux86`` and ``qemuarm``, see the
:doc:`../sdk-manual/sdk-manual` manual. For :doc:`../sdk-manual/index` manual. For
information about how to install these images, see the documentation information about how to install these images, see the documentation
for your particular board or machine. for your particular board or machine.

View File

@@ -31,13 +31,13 @@ This manual provides the following:
This manual does not provide the following: This manual does not provide the following:
- Redundant Step-by-step Instructions: For example, the - Redundant Step-by-step Instructions: For 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 instructions on how to install an SDK, which is used to develop
applications for target hardware. applications for target hardware.
- Reference or Conceptual Material: This type of material resides in an - Reference or Conceptual Material: This type of material resides in an
appropriate reference manual. For example, system variables are appropriate reference manual. For example, system variables are
documented in the :doc:`../ref-manual/ref-manual`. documented in the :doc:`../ref-manual/index`.
- Detailed Public Information Not Specific to the Yocto Project: For - Detailed Public Information Not Specific to the Yocto Project: For
example, exhaustive information on how to use the Source Control example, exhaustive information on how to use the Source Control
@@ -52,7 +52,7 @@ supplemental information is recommended for full comprehension. For
introductory information on the Yocto Project, see the introductory information on the Yocto Project, see the
:yocto_home:`Yocto Project Website <>`. If you want to build an image with no :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 knowledge of Yocto Project as a way of quickly testing it out, see the
:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. :doc:`../brief-yoctoprojectqs/index` document.
For a comprehensive list of links and other documentation, see the For a comprehensive list of links and other documentation, see the
":ref:`ref-manual/resources:links and related documentation`" ":ref:`ref-manual/resources:links and related documentation`"

View File

@@ -344,7 +344,7 @@ going to use BitBake, see the
section. If you are going section. If you are going
to use the Extensible SDK, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto to use the Extensible SDK, see the ":doc:`../sdk-manual/sdk-extensible`" Chapter in the Yocto
Project Application Development and the Extensible Software Development Project Application Development and the Extensible Software Development
Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`../kernel-dev/kernel-dev`. If you are going to use Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`../kernel-dev/index`. If you are going to use
Toaster, see the ":doc:`../toaster-manual/toaster-manual-setup-and-use`" Toaster, see the ":doc:`../toaster-manual/toaster-manual-setup-and-use`"
section in the Toaster User Manual. section in the Toaster User Manual.

View File

@@ -14,7 +14,7 @@ Welcome to the Yocto Project Documentation
:maxdepth: 1 :maxdepth: 1
:caption: Introduction and Overview :caption: Introduction and Overview
Quick Build <brief-yoctoprojectqs/brief-yoctoprojectqs> Quick Build <brief-yoctoprojectqs/index>
what-i-wish-id-known what-i-wish-id-known
transitioning-to-a-custom-environment transitioning-to-a-custom-environment
Yocto Project Software Overview <https://www.yoctoproject.org/software-overview/> Yocto Project Software Overview <https://www.yoctoproject.org/software-overview/>
@@ -25,15 +25,15 @@ Welcome to the Yocto Project Documentation
:maxdepth: 1 :maxdepth: 1
:caption: Manuals :caption: Manuals
Overview and Concepts Manual <overview-manual/overview-manual> Overview and Concepts Manual <overview-manual/index>
Reference Manual <ref-manual/ref-manual> Reference Manual <ref-manual/index>
Board Support Package (BSP) Developer's guide <bsp-guide/bsp-guide> Board Support Package (BSP) Developer's guide <bsp-guide/index>
Development Tasks Manual <dev-manual/dev-manual> Development Tasks Manual <dev-manual/index>
Linux Kernel Development Manual <kernel-dev/kernel-dev> Linux Kernel Development Manual <kernel-dev/index>
Profile and Tracing Manual <profile-manual/profile-manual> Profile and Tracing Manual <profile-manual/index>
Application Development and the Extensible SDK (eSDK) <sdk-manual/sdk-manual> Application Development and the Extensible SDK (eSDK) <sdk-manual/index>
Toaster Manual <toaster-manual/toaster-manual> Toaster Manual <toaster-manual/index>
Test Environment Manual <test-manual/test-manual> Test Environment Manual <test-manual/index>
Bitbake User Manual <https://docs.yoctoproject.org/bitbake> Bitbake User Manual <https://docs.yoctoproject.org/bitbake>
.. toctree:: .. toctree::

View File

@@ -474,7 +474,7 @@ supported kernel type.
This section overviews the BSP description structure, the aggregation This section overviews the BSP description structure, the aggregation
concepts, and presents a detailed example using a BSP supported by the concepts, and presents a detailed example using a BSP supported by the
Yocto Project (i.e. BeagleBone Board). For complete information on BSP 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 Description Overview
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~

View File

@@ -502,7 +502,7 @@ your layer in the following area:
.. note:: .. note::
If you are working on a new machine Board Support Package (BSP), be 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 As an example, consider the following append file used by the BSPs in
``meta-yocto-bsp``: ``meta-yocto-bsp``:

View File

@@ -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 you need some additional background, please be sure to review and
understand the following documentation: 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 - :ref:`devtool
workflow <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>` workflow <sdk-manual/sdk-extensible:using \`\`devtool\`\` in your sdk workflow>`

View File

@@ -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 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 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 defined for BSP layers. You can learn more about this structure in the
:doc:`../bsp-guide/bsp-guide`. :doc:`../bsp-guide/index`.
.. note:: .. note::
@@ -1366,7 +1366,7 @@ can initialize the environment before using the tools.
section. section.
- For information on setting up a cross-development environment, see - 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 All the output files for an SDK are written to the ``deploy/sdk`` folder
inside the :term:`Build Directory` as 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 creating :ref:`sdk-manual/sdk-intro:the cross-development toolchain`. This
section provides some technical background on how cross-development section provides some technical background on how cross-development
toolchains are created and used. For more information on toolchains, you 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 In the Yocto Project development environment, cross-development
toolchains are used to build images and applications that run on the toolchains are used to build images and applications that run on the

View File

@@ -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 hardware. To development BSPs, you need to take some additional steps
beyond what was described in setting up a development host. 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 information. For specifics on development host preparation, see the
":ref:`bsp-guide/bsp:preparing your build host to work with bsp layers`" ":ref:`bsp-guide/bsp:preparing your build host to work with bsp layers`"
section in the Yocto Project Board Support Package (BSP) Developer's 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 using ``devtool`` makes kernel development quicker by reducing
iteration cycle times. 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 development information. For specifics on development host
preparation, see the preparation, see the
":ref:`kernel-dev/kernel-dev-common:preparing the build host to work on the kernel`" ":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 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 Toaster and on how to use Toaster in general, see the
:doc:`../toaster-manual/toaster-manual`. :doc:`../toaster-manual/index`.
Yocto Project Source Repositories Yocto Project Source Repositories
================================= =================================

View File

@@ -37,17 +37,17 @@ This manual does not give you the following:
- *Step-by-step Instructions for Development Tasks:* Instructional - *Step-by-step Instructions for Development Tasks:* Instructional
procedures reside in other manuals within the Yocto Project 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 provides examples on how to perform
various development tasks. As another example, the 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 instructions on how to install an SDK, which is used to develop
applications for target hardware. applications for target hardware.
- *Reference Material:* This type of material resides in an appropriate - *Reference Material:* This type of material resides in an appropriate
reference manual. For example, system variables are documented in the reference manual. For example, system variables are documented in the
:doc:`../ref-manual/ref-manual`. As another :doc:`../ref-manual/index`. As another
example, the :doc:`../bsp-guide/bsp-guide` contains reference information on example, the :doc:`../bsp-guide/index` contains reference information on
BSPs. BSPs.
- *Detailed Public Information Not Specific to the Yocto Project:* For - *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 additional introductory information on the Yocto Project, see the
:yocto_home:`Yocto Project Website <>`. If you want to build an image :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, 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 For a comprehensive list of links and other documentation, see the
":ref:`Links and Related ":ref:`Links and Related
Documentation <resources-links-and-related-documentation>`" Documentation <resources-links-and-related-documentation>`"

View File

@@ -251,7 +251,7 @@ accomplish this through a recipe that is a BitBake append
.. note:: .. note::
For general information on BSP layer structure, see the For general information on BSP layer structure, see the
:doc:`../bsp-guide/bsp-guide` :doc:`../bsp-guide/index`
. .
The :term:`Source Directory` The :term:`Source Directory`
@@ -339,12 +339,12 @@ applications using the Yocto Project:
experience supplemented with the powerful set of ``devtool`` commands experience supplemented with the powerful set of ``devtool`` commands
tailored for the Yocto Project environment. 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 - *Toaster:* Toaster is a web interface to the Yocto Project
OpenEmbedded build system. Toaster allows you to configure, run, and OpenEmbedded build system. Toaster allows you to configure, run, and
view information about builds. For information on Toaster, see the view information about builds. For information on Toaster, see the
:doc:`../toaster-manual/toaster-manual`. :doc:`../toaster-manual/index`.
Production Tools Production Tools
---------------- ----------------
@@ -650,7 +650,7 @@ Project.
configure and start builds on multiple remote build servers. configure and start builds on multiple remote build servers.
For information about and how to use Toaster, see the For information about and how to use Toaster, see the
:doc:`../toaster-manual/toaster-manual`. :doc:`../toaster-manual/index`.
Reference Embedded Distribution (Poky) Reference Embedded Distribution (Poky)
====================================== ======================================
@@ -812,7 +812,7 @@ helpful for getting started:
application developers. This eSDK allows developers to incorporate application developers. This eSDK allows developers to incorporate
their library and programming changes back into the image to make their library and programming changes back into the image to make
their code available to other application developers. For information 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 - *Layer:* A collection of related recipes. Layers allow you to
consolidate related metadata to customize your build. Layers also consolidate related metadata to customize your build. Layers also

View File

@@ -47,7 +47,7 @@ Support Package (BSP) layer for it. For more information on how to
create a BSP layer, see the create a BSP layer, see the
":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`" ":ref:`dev-manual/dev-manual-common-tasks:understanding and creating layers`"
section in the Yocto Project Development Tasks Manual and the 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 Usually, if the board is not completely exotic, adding support in the
Yocto Project is fairly straightforward. Yocto Project is fairly straightforward.

View File

@@ -234,7 +234,7 @@ functionality almost completely overlapped with the :ref:`standard
SDK <sdk-manual/sdk-using:using the standard sdk>` and the SDK <sdk-manual/sdk-using:using the standard sdk>` and the
:ref:`extensible SDK <sdk-manual/sdk-extensible:using the extensible sdk>`. For :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 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:: .. note::

View File

@@ -261,7 +261,7 @@ these valid features is as follows:
- *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and - *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and
``LTTng``. For general information on user-space tools, see the ``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. - *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 ``gdb``. For information on GDB, see the
":ref:`dev-manual/dev-manual-common-tasks:debugging with the gnu project debugger (gdb) remotely`" section ":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 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. - *tools-sdk:* Installs a full SDK that runs on the device.

View File

@@ -104,7 +104,7 @@ metadata to define the Poky reference distribution.
This directory contains the Yocto Project reference hardware Board This directory contains the Yocto Project reference hardware Board
Support Packages (BSPs). For more information on BSPs, see the Support Packages (BSPs). For more information on BSPs, see the
:doc:`../bsp-guide/bsp-guide`. :doc:`../bsp-guide/index`.
.. _structure-meta-selftest: .. _structure-meta-selftest:

View File

@@ -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 If you want to use the Yocto Project to quickly build an image without
having to understand concepts, work through the having to understand concepts, work through the
:doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. You can find "how-to" :doc:`../brief-yoctoprojectqs/index` document. You can find "how-to"
information in the :doc:`../dev-manual/dev-manual`. You can find Yocto Project overview information in the :doc:`../dev-manual/index`. You can find Yocto Project overview
and conceptual information in the :doc:`../overview-manual/overview-manual`. and conceptual information in the :doc:`../overview-manual/index`.
.. note:: .. note::

View File

@@ -58,8 +58,7 @@ universal, the list includes them just in case:
:term:`Board Support Package (BSP)` :term:`Board Support Package (BSP)`
A group of drivers, definitions, and other components that provide support A group of drivers, definitions, and other components that provide support
for a specific hardware configuration. For more information on BSPs, see for a specific hardware configuration. For more information on BSPs, see
the :ref:`bsp-guide/bsp-guide:Yocto Project Board Support Package the :doc:`/bsp-guide/index`.
Developer's Guide`.
:term:`Build Directory` :term:`Build Directory`
This term refers to the area used by the OpenEmbedded build system for 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 ":ref:`overview-manual/overview-manual-concepts:Cross-Development
Toolchain Generation`" section in the Yocto Project Overview and Concepts Toolchain Generation`" section in the Yocto Project Overview and Concepts
Manual. You can also find more information on using the relocatable Manual. You can also find more information on using the relocatable
toolchain in the :ref:`sdk-manual/sdk-manual:Yocto Project Application toolchain in the :doc:`/sdk-manual/index` manual.
Development and the Extensible Software Development Kit (eSDK)` manual.
:term:`Extensible Software Development Kit (eSDK)` :term:`Extensible Software Development Kit (eSDK)`
A custom SDK for application developers. This eSDK allows developers to A custom SDK for application developers. This eSDK allows developers to
incorporate their library and programming changes back into the image to incorporate their library and programming changes back into the image to
make their code available to other application developers. make their code available to other application developers.
For information on the eSDK, see the :ref:`sdk-manual/sdk-manual:Yocto For information on the eSDK, see the :doc:`/sdk-manual/index` manual.
Project Application Development and the Extensible Software Development
Kit (eSDK)` manual.
:term:`Image` :term:`Image`
An image is an artifact of the BitBake build process given a collection of 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 The interface enables you to
configure and run your builds. Information about builds is collected configure and run your builds. Information about builds is collected
and stored in a database. For information on Toaster, see the and stored in a database. For information on Toaster, see the
:doc:`../toaster-manual/toaster-manual`. :doc:`../toaster-manual/index`.
:term:`Upstream` :term:`Upstream`
A reference to source code or repositories that are not A reference to source code or repositories that are not

View File

@@ -8154,7 +8154,7 @@ system and gives an overview of their function and contents.
":ref:`sdk-manual/sdk-intro:the cross-development toolchain`" ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`"
section in the Yocto Project Overview and Concepts Manual. For section in the Yocto Project Overview and Concepts Manual. For
information on setting up a cross-development environment, see the information on setting up a cross-development environment, see the
:doc:`../sdk-manual/sdk-manual` manual. :doc:`../sdk-manual/index` manual.
:term:`TOOLCHAIN_OUTPUTNAME` :term:`TOOLCHAIN_OUTPUTNAME`
This variable defines the name used for the toolchain output. The 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`" ":ref:`sdk-manual/sdk-intro:the cross-development toolchain`"
section in the Yocto Project Overview and Concepts Manual. For section in the Yocto Project Overview and Concepts Manual. For
information on setting up a cross-development environment, see the information on setting up a cross-development environment, see the
:doc:`../sdk-manual/sdk-manual` manual. :doc:`../sdk-manual/index` manual.
:term:`TOPDIR` :term:`TOPDIR`
The top-level :term:`Build Directory`. BitBake The top-level :term:`Build Directory`. BitBake

View File

@@ -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 guide to the BitBake tool. If you want information on BitBake, see
this manual. this manual.
- :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` *:* This - :doc:`../brief-yoctoprojectqs/index` *:* This
short document lets you experience building an image using the Yocto short document lets you experience building an image using the Yocto
Project without having to understand any concepts or details. 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. 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 that presents procedures useful to both application and system
developers who use the Yocto Project. 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 guide provides information that lets you get going with the standard
or extensible SDK. An SDK, with its cross-development toolchains, or extensible SDK. An SDK, with its cross-development toolchains,
allows you to develop projects inside or outside of the Yocto Project 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 for BSP components. Having a commonly understood structure encourages
standardization. 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 how to work with Linux Yocto kernels as well as provides a bit of
conceptual information on the construction of the Yocto Linux kernel conceptual information on the construction of the Yocto Linux kernel
tree. tree.
- :doc:`../ref-manual/ref-manual` *:* This - :doc:`../ref-manual/index` *:* This
manual provides reference material such as variable, task, and class manual provides reference material such as variable, task, and class
descriptions. 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 which you can easily search for phrases and terms used in the Yocto
Project documentation set. 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 common and generally useful tracing and profiling schemes along with
their applications (as appropriate) to each tool. 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 introduces and describes how to set up and use Toaster. Toaster is an
Application Programming Interface (API) and web-based interface to Application Programming Interface (API) and web-based interface to
the :term:`OpenEmbedded Build System`, which uses the :term:`OpenEmbedded Build System`, which uses

View File

@@ -8,7 +8,7 @@ Transitioning to a custom environment for systems development
.. note:: .. note::
So you've finished the :doc:`brief-yoctoprojectqs/brief-yoctoprojectqs` and So you've finished the :doc:`brief-yoctoprojectqs/index` and
glanced over the document :doc:`what-i-wish-id-known`, the latter contains glanced over the document :doc:`what-i-wish-id-known`, the latter contains
important information learned from other users. You're well prepared. But important information learned from other users. You're well prepared. But
now, as you are starting your own project, it isn't exactly straightforward what now, as you are starting your own project, it isn't exactly straightforward what

View File

@@ -49,7 +49,7 @@ contact us with other suggestions.
their silicon. These layers have names such as "meta-intel" or "meta-ti". Try their silicon. These layers have names such as "meta-intel" or "meta-ti". Try
not to build layers from scratch. If you do have custom silicon, use one of not to build layers from scratch. If you do have custom silicon, use one of
these layers as a guide or template and familiarize yourself with the these layers as a guide or template and familiarize yourself with the
:doc:`bsp-guide/bsp-guide`. :doc:`bsp-guide/index`.
#. **Do not put everything into one layer:** #. **Do not put everything into one layer:**
Use different layers to logically separate information in your build. As an Use different layers to logically separate information in your build. As an
@@ -126,7 +126,7 @@ contact us with other suggestions.
You can build and run a specific task for a specific package (including You can build and run a specific task for a specific package (including
devshell) or even a single recipe. When developers first start using the devshell) or even a single recipe. When developers first start using the
Yocto Project, the instructions found in the Yocto Project, the instructions found in the
:doc:`brief-yoctoprojectqs/brief-yoctoprojectqs` show how to create an image :doc:`brief-yoctoprojectqs/index` show how to create an image
and then run or flash that image. However, you can actually build just a and then run or flash that image. However, you can actually build just a
single recipe. Thus, if some dependency or recipe isn't working, you can just single recipe. Thus, if some dependency or recipe isn't working, you can just
say "bitbake foo" where "foo" is the name for a specific recipe. As you say "bitbake foo" where "foo" is the name for a specific recipe. As you
@@ -190,7 +190,7 @@ contact us with other suggestions.
contains procedural information grouped to help you get set up, work with contains procedural information grouped to help you get set up, work with
layers, customize images, write new recipes, work with libraries, and use layers, customize images, write new recipes, work with libraries, and use
QEMU. The information is task-based and spans the breadth of the Yocto QEMU. The information is task-based and spans the breadth of the Yocto
Project. See the :doc:`../dev-manual/dev-manual`. Project. See the :doc:`../dev-manual/index`.
* **Look Through the Yocto Project Application Development and the Extensible * **Look Through the Yocto Project Application Development and the Extensible
Software Development Kit (eSDK) manual**: This manual describes how to use Software Development Kit (eSDK) manual**: This manual describes how to use
@@ -201,17 +201,17 @@ contact us with other suggestions.
for more information. for more information.
* **Learn About Kernel Development**: If you want to see how to work with the * **Learn About Kernel Development**: If you want to see how to work with the
kernel and understand Yocto Linux kernels, see the :doc:`../kernel-dev/kernel-dev`. kernel and understand Yocto Linux kernels, see the :doc:`../kernel-dev/index`.
This manual provides information on how to patch the kernel, modify kernel This manual provides information on how to patch the kernel, modify kernel
recipes, and configure the kernel. recipes, and configure the kernel.
* **Learn About Board Support Packages (BSPs)**: If you want to learn about * **Learn About Board Support Packages (BSPs)**: If you want to learn about
BSPs, see the :doc:`../bsp-guide/bsp-guide`. This manual also provides an BSPs, see the :doc:`../bsp-guide/index`. This manual also provides an
example BSP creation workflow. See the :doc:`../bsp-guide/bsp` section. example BSP creation workflow. See the :doc:`../bsp-guide/bsp` section.
* **Learn About Toaster**: Toaster is a web interface to the Yocto Project's * **Learn About Toaster**: Toaster is a web interface to the Yocto Project's
OpenEmbedded build system. If you are interested in using this type of OpenEmbedded build system. If you are interested in using this type of
interface to create images, see the :doc:`../toaster-manual/toaster-manual`. interface to create images, see the :doc:`../toaster-manual/index`.
* **Have Available the Yocto Project Reference Manual**: Unlike the rest of * **Have Available the Yocto Project Reference Manual**: Unlike the rest of
the Yocto Project manual set, this manual is comprised of material suited the Yocto Project manual set, this manual is comprised of material suited
@@ -219,7 +219,7 @@ contact us with other suggestions.
look at how the pieces of the Yocto Project development environment work look at how the pieces of the Yocto Project development environment work
together, information on various technical details, guidance on migrating together, information on various technical details, guidance on migrating
to a newer Yocto Project release, reference material on the directory to a newer Yocto Project release, reference material on the directory
structure, classes, and tasks. The :doc:`../ref-manual/ref-manual` also structure, classes, and tasks. The :doc:`../ref-manual/index` also
contains a fairly comprehensive glossary of variables used within the Yocto contains a fairly comprehensive glossary of variables used within the Yocto
Project. Project.