mirror of
https://git.yoctoproject.org/poky
synced 2026-05-30 12:29:55 +00:00
sphinx: use absolute paths for :doc: references
:doc: references can be made with absolute path instead of relative path. This patch was generated with this command: sed -i 's!:doc:`\.\./!:doc:`/!g' */*.rst *.rst And a few manual fixup we made for references such as: :doc:"FOOBAR <../xxx>" Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: b7948ec7eb8172b8eae4bfa5c21aab76e123ad85) 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
bd17892611
commit
097d0c9f04
@@ -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/index`.
|
||||
:doc:`/bsp-guide/index`.
|
||||
|
||||
.. note::
|
||||
|
||||
@@ -1285,7 +1285,7 @@ this output:
|
||||
.. note::
|
||||
|
||||
For a list of example images that the Yocto Project provides, see the
|
||||
":doc:`../ref-manual/ref-images`" chapter in the Yocto Project Reference
|
||||
":doc:`/ref-manual/ref-images`" chapter in the Yocto Project Reference
|
||||
Manual.
|
||||
|
||||
The build process writes images out to the :term:`Build Directory`
|
||||
@@ -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/index` 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/index` 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/index` 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/index` 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/index`.
|
||||
: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/index`
|
||||
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/index` 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/index`. As another
|
||||
example, the :doc:`../bsp-guide/index` 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/index` 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>`"
|
||||
|
||||
@@ -111,7 +111,7 @@ Project:
|
||||
development.
|
||||
|
||||
- *Releases According to a Strict Schedule:* Major releases occur on a
|
||||
:doc:`six-month cycle <../ref-manual/ref-release-process>`
|
||||
:doc:`six-month cycle </ref-manual/ref-release-process>`
|
||||
predictably in October and April. The most recent two releases
|
||||
support point releases to address common vulnerabilities and
|
||||
exposures. This predictability is crucial for projects based on the
|
||||
@@ -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/index`
|
||||
: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/index` 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/index`.
|
||||
:doc:`/toaster-manual/index`.
|
||||
|
||||
Production Tools
|
||||
----------------
|
||||
@@ -392,7 +392,7 @@ activities using the Yocto Project:
|
||||
benefit of the development community.
|
||||
|
||||
You can learn more about the AutoBuilder used by the Yocto Project
|
||||
Autobuilder :doc:`here <../test-manual/test-manual-understand-autobuilder>`.
|
||||
Autobuilder :doc:`here </test-manual/test-manual-understand-autobuilder>`.
|
||||
|
||||
- *Cross-Prelink:* Prelinking is the process of pre-computing the load
|
||||
addresses and link tables generated by the dynamic linker as compared
|
||||
@@ -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/index`.
|
||||
:doc:`/toaster-manual/index`.
|
||||
|
||||
Reference Embedded Distribution (Poky)
|
||||
======================================
|
||||
@@ -720,7 +720,7 @@ Poky has a regular, well established, six-month release cycle under its
|
||||
own version. Major releases occur at the same time major releases (point
|
||||
releases) occur for the Yocto Project, which are typically in the Spring
|
||||
and Fall. For more information on the Yocto Project release schedule and
|
||||
cadence, see the ":doc:`../ref-manual/ref-release-process`" chapter in the
|
||||
cadence, see the ":doc:`/ref-manual/ref-release-process`" chapter in the
|
||||
Yocto Project Reference Manual.
|
||||
|
||||
Much has been said about Poky being a "default configuration". A default
|
||||
@@ -798,7 +798,7 @@ Some Basic Terms
|
||||
|
||||
It helps to understand some basic fundamental terms when learning the
|
||||
Yocto Project. Although a list of terms exists in the ":doc:`Yocto Project
|
||||
Terms <../ref-manual/ref-terms>`" section of the Yocto Project
|
||||
Terms </ref-manual/ref-terms>`" section of the Yocto Project
|
||||
Reference Manual, this section provides the definitions of some terms
|
||||
helpful for getting started:
|
||||
|
||||
@@ -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/index` 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
|
||||
|
||||
Reference in New Issue
Block a user