diff options
| author | Quentin Schulz <quentin.schulz@cherry.de> | 2025-06-18 17:13:35 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-06-20 09:48:15 +0100 |
| commit | bebe66feaee45e1e280a63e089bd894bc9227ee5 (patch) | |
| tree | 3cc194e3b6a9816099c92ceeace02d1d152683b1 /documentation/ref-manual | |
| parent | 931db3845c12129322c07b007f2e7831a304d231 (diff) | |
| download | poky-bebe66feaee45e1e280a63e089bd894bc9227ee5.tar.gz | |
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>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/resources.rst | 4 | ||||
| -rw-r--r-- | documentation/ref-manual/system-requirements.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 4eaaca942e..bcbc7ebaca 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
| @@ -23,7 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes | |||
| 23 | to the project either by creating and sending pull requests, or by | 23 | to the project either by creating and sending pull requests, or by |
| 24 | submitting patches through email. For information on how to do both as | 24 | submitting patches through email. For information on how to do both as |
| 25 | well as information on how to identify the maintainer for each area of | 25 | well as information on how to identify the maintainer for each area of |
| 26 | code, see the :doc:`../contributor-guide/index`. | 26 | code, see the :doc:`/contributor-guide/index`. |
| 27 | 27 | ||
| 28 | .. _resources-bugtracker: | 28 | .. _resources-bugtracker: |
| 29 | 29 | ||
| @@ -45,7 +45,7 @@ your expectations). | |||
| 45 | For a general procedure and guidelines on how to use Bugzilla to submit a bug | 45 | For a general procedure and guidelines on how to use Bugzilla to submit a bug |
| 46 | against the Yocto Project, see the following: | 46 | against the Yocto Project, see the following: |
| 47 | 47 | ||
| 48 | - The ":doc:`../contributor-guide/report-defect`" | 48 | - The ":doc:`/contributor-guide/report-defect`" |
| 49 | section in the Yocto Project and OpenEmbedded Contributor Guide. | 49 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
| 50 | 50 | ||
| 51 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 51 | - The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index b64a13320a..14b635013b 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
| @@ -145,7 +145,7 @@ tested on former revisions of "&DISTRO_NAME;", but no longer are: | |||
| 145 | interested in hearing about your experience. For information on | 145 | interested in hearing about your experience. For information on |
| 146 | how to submit a bug, see the Yocto Project | 146 | how to submit a bug, see the Yocto Project |
| 147 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 147 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
| 148 | and the ":doc:`../contributor-guide/report-defect`" | 148 | and the ":doc:`/contributor-guide/report-defect`" |
| 149 | section in the Yocto Project and OpenEmbedded Contributor Guide. | 149 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
| 150 | 150 | ||
| 151 | Required Packages for the Build Host | 151 | Required Packages for the Build Host |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index fd14274a13..65c54f3861 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -2576,7 +2576,7 @@ system and gives an overview of their function and contents. | |||
| 2576 | You can safely share this directory between multiple builds on the | 2576 | You can safely share this directory between multiple builds on the |
| 2577 | same development machine. For additional information on how the build | 2577 | same development machine. For additional information on how the build |
| 2578 | process gets source files when working behind a firewall or proxy | 2578 | process gets source files when working behind a firewall or proxy |
| 2579 | server, see this specific question in the ":doc:`faq`" | 2579 | server, see this specific question in the ":doc:`/ref-manual/faq`" |
| 2580 | chapter. You can also refer to the | 2580 | chapter. You can also refer to the |
| 2581 | ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" | 2581 | ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" |
| 2582 | Wiki page. | 2582 | Wiki page. |
