tree-wide: make the :doc: directive use absolute paths

This makes all :doc: directives use an absolute paths (with the root
directory being documentation/ in the repo).

This is then consistent across the whole source and is easier to review
and move files around, you just need to know where a file is located
relative to documentation/ directory and use that.

This gets rid of paths looking in parent directory with '..' as well as
expecting a file to be in the same directory as the other file it points
to via the :doc: directive.

(From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Quentin Schulz
2025-06-18 17:13:35 +02:00
committed by Richard Purdie
parent 931db3845c
commit bebe66feae
14 changed files with 24 additions and 24 deletions

View File

@@ -48,7 +48,7 @@ The following figure and list overviews the build process:
:width: 100%
#. *Set up Your Host Development System to Support Development Using the
Yocto Project*: See the ":doc:`start`" section for options on how to get a
Yocto Project*: See the ":doc:`/dev-manual/start`" section for options on how to get a
build host ready to use the Yocto Project.
#. *Initialize the Build Environment:* Initialize the build environment
@@ -113,7 +113,7 @@ The following figure and list overviews the build process:
Building Images for Multiple Targets Using Multiple Configurations
==================================================================
See the :doc:`multiconfig` section of the Yocto Project Development Tasks
See the :doc:`/dev-manual/multiconfig` section of the Yocto Project Development Tasks
Manual.
Building an Initial RAM Filesystem (Initramfs) Image

View File

@@ -890,7 +890,7 @@ The build should work without issue.
As with all solved problems, if they originated upstream, you need to
submit the fix for the recipe in OE-Core and upstream so that the
problem is taken care of at its source. See the
":doc:`../contributor-guide/submit-changes`" section for more information.
":doc:`/contributor-guide/submit-changes`" section for more information.
Debugging With the GNU Project Debugger (GDB) Remotely
======================================================
@@ -1261,7 +1261,7 @@ Here are some other tips that you might find useful:
:yocto_bugs:`Bugzilla <>`. For information on
how to submit a bug against the Yocto Project, see the Yocto Project
Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
and the ":doc:`../contributor-guide/report-defect`" section.
and the ":doc:`/contributor-guide/report-defect`" section.
.. note::

View File

@@ -1401,7 +1401,7 @@ Following Recipe Style Guidelines
=================================
When writing recipes, it is good to conform to existing style guidelines.
See the ":doc:`../contributor-guide/recipe-style-guide`" in the Yocto Project
See the ":doc:`/contributor-guide/recipe-style-guide`" in the Yocto Project
and OpenEmbedded Contributor Guide for reference.
It is common for existing recipes to deviate a bit from this style.

View File

@@ -234,7 +234,7 @@ particular working environment and set of practices.
- The Yocto Project community encourages you to send patches to the
project to fix bugs or add features. If you do submit patches,
follow the project commit guidelines for writing good commit
messages. See the ":doc:`../contributor-guide/submit-changes`"
messages. See the ":doc:`/contributor-guide/submit-changes`"
section in the Yocto Project and OpenEmbedded Contributor Guide.
- Send changes to the core sooner than later as others are likely

View File

@@ -22,7 +22,7 @@ issues may be impacting Poky and OE-Core. It is up to the maintainers, users,
contributors and anyone interested in the issues to investigate and possibly fix them by
updating software components to newer versions or by applying patches to address them.
It is recommended to work with Poky and OE-Core upstream maintainers and submit
patches to fix them, see ":doc:`../contributor-guide/submit-changes`" for details.
patches to fix them, see ":doc:`/contributor-guide/submit-changes`" for details.
Vulnerability check at build time
=================================