summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@cherry.de>2025-06-18 17:13:35 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-06-20 09:48:15 +0100
commitbebe66feaee45e1e280a63e089bd894bc9227ee5 (patch)
tree3cc194e3b6a9816099c92ceeace02d1d152683b1
parent931db3845c12129322c07b007f2e7831a304d231 (diff)
downloadpoky-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>
-rw-r--r--documentation/bsp-guide/bsp.rst4
-rw-r--r--documentation/contributor-guide/submit-changes.rst4
-rw-r--r--documentation/dev-manual/building.rst4
-rw-r--r--documentation/dev-manual/debugging.rst4
-rw-r--r--documentation/dev-manual/new-recipe.rst2
-rw-r--r--documentation/dev-manual/start.rst2
-rw-r--r--documentation/dev-manual/vulnerabilities.rst2
-rw-r--r--documentation/migration-guides/release-notes-4.3.rst4
-rw-r--r--documentation/overview-manual/development-environment.rst6
-rw-r--r--documentation/ref-manual/resources.rst4
-rw-r--r--documentation/ref-manual/system-requirements.rst2
-rw-r--r--documentation/ref-manual/variables.rst2
-rw-r--r--documentation/transitioning-to-a-custom-environment.rst4
-rw-r--r--documentation/what-i-wish-id-known.rst4
14 files changed, 24 insertions, 24 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 4a24fc3ffc..9fe4ac7722 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -881,7 +881,7 @@ The requirements for a released BSP that conform to the Yocto Project are:
881 ``recipes-*`` subdirectories specific to the recipe's function, or 881 ``recipes-*`` subdirectories specific to the recipe's function, or
882 within a subdirectory containing a set of closely-related recipes. 882 within a subdirectory containing a set of closely-related recipes.
883 The recipes themselves should follow the general guidelines for 883 The recipes themselves should follow the general guidelines for
884 recipes found in the ":doc:`../contributor-guide/recipe-style-guide`" 884 recipes found in the ":doc:`/contributor-guide/recipe-style-guide`"
885 in the Yocto Project and OpenEmbedded Contributor Guide. 885 in the Yocto Project and OpenEmbedded Contributor Guide.
886 886
887- *License File:* You must include a license file in the 887- *License File:* You must include a license file in the
@@ -915,7 +915,7 @@ The requirements for a released BSP that conform to the Yocto Project are:
915 - The name and contact information for the BSP layer maintainer. 915 - The name and contact information for the BSP layer maintainer.
916 This is the person to whom patches and questions should be sent. 916 This is the person to whom patches and questions should be sent.
917 For information on how to find the right person, see the 917 For information on how to find the right person, see the
918 :doc:`../contributor-guide/submit-changes` section in the Yocto Project and 918 :doc:`/contributor-guide/submit-changes` section in the Yocto Project and
919 OpenEmbedded Contributor Guide. 919 OpenEmbedded Contributor Guide.
920 920
921 - Instructions on how to build the BSP using the BSP layer. 921 - Instructions on how to build the BSP using the BSP layer.
diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst
index 6d5d69d7cf..adb78fa08d 100644
--- a/documentation/contributor-guide/submit-changes.rst
+++ b/documentation/contributor-guide/submit-changes.rst
@@ -76,7 +76,7 @@ Clone the Git repository for the component to modify
76---------------------------------------------------- 76----------------------------------------------------
77 77
78After identifying the component to modify as described in the 78After identifying the component to modify as described in the
79":doc:`../contributor-guide/identify-component`" section, clone the 79":doc:`/contributor-guide/identify-component`" section, clone the
80corresponding Git repository. Here is an example for OpenEmbedded-Core:: 80corresponding Git repository. Here is an example for OpenEmbedded-Core::
81 81
82 git clone https://git.openembedded.org/openembedded-core 82 git clone https://git.openembedded.org/openembedded-core
@@ -872,7 +872,7 @@ in regards to the use of generative AI tools. See:
872https://www.linuxfoundation.org/legal/generative-ai. 872https://www.linuxfoundation.org/legal/generative-ai.
873 873
874All of the existing guidelines in this document are expected to be followed, 874All of the existing guidelines in this document are expected to be followed,
875including in the :doc:`recipe-style-guide`, and contributing the changes with 875including in the :doc:`/contributor-guide/recipe-style-guide`, and contributing the changes with
876additional requirements to the items in section 876additional requirements to the items in section
877:ref:`contributor-guide/submit-changes:Implement and commit changes`. 877:ref:`contributor-guide/submit-changes:Implement and commit changes`.
878 878
diff --git a/documentation/dev-manual/building.rst b/documentation/dev-manual/building.rst
index 807c665f68..865d2e1b67 100644
--- a/documentation/dev-manual/building.rst
+++ b/documentation/dev-manual/building.rst
@@ -48,7 +48,7 @@ The following figure and list overviews the build process:
48 :width: 100% 48 :width: 100%
49 49
50#. *Set up Your Host Development System to Support Development Using the 50#. *Set up Your Host Development System to Support Development Using the
51 Yocto Project*: See the ":doc:`start`" section for options on how to get a 51 Yocto Project*: See the ":doc:`/dev-manual/start`" section for options on how to get a
52 build host ready to use the Yocto Project. 52 build host ready to use the Yocto Project.
53 53
54#. *Initialize the Build Environment:* Initialize the build environment 54#. *Initialize the Build Environment:* Initialize the build environment
@@ -113,7 +113,7 @@ The following figure and list overviews the build process:
113Building Images for Multiple Targets Using Multiple Configurations 113Building Images for Multiple Targets Using Multiple Configurations
114================================================================== 114==================================================================
115 115
116See the :doc:`multiconfig` section of the Yocto Project Development Tasks 116See the :doc:`/dev-manual/multiconfig` section of the Yocto Project Development Tasks
117Manual. 117Manual.
118 118
119Building an Initial RAM Filesystem (Initramfs) Image 119Building an Initial RAM Filesystem (Initramfs) Image
diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst
index 8552b26aea..6c45ccf652 100644
--- a/documentation/dev-manual/debugging.rst
+++ b/documentation/dev-manual/debugging.rst
@@ -890,7 +890,7 @@ The build should work without issue.
890As with all solved problems, if they originated upstream, you need to 890As with all solved problems, if they originated upstream, you need to
891submit the fix for the recipe in OE-Core and upstream so that the 891submit the fix for the recipe in OE-Core and upstream so that the
892problem is taken care of at its source. See the 892problem is taken care of at its source. See the
893":doc:`../contributor-guide/submit-changes`" section for more information. 893":doc:`/contributor-guide/submit-changes`" section for more information.
894 894
895Debugging With the GNU Project Debugger (GDB) Remotely 895Debugging With the GNU Project Debugger (GDB) Remotely
896====================================================== 896======================================================
@@ -1261,7 +1261,7 @@ Here are some other tips that you might find useful:
1261 :yocto_bugs:`Bugzilla <>`. For information on 1261 :yocto_bugs:`Bugzilla <>`. For information on
1262 how to submit a bug against the Yocto Project, see the Yocto Project 1262 how to submit a bug against the Yocto Project, see the Yocto Project
1263 Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>` 1263 Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
1264 and the ":doc:`../contributor-guide/report-defect`" section. 1264 and the ":doc:`/contributor-guide/report-defect`" section.
1265 1265
1266 .. note:: 1266 .. note::
1267 1267
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst
index 9792bd4c1f..c49881efe6 100644
--- a/documentation/dev-manual/new-recipe.rst
+++ b/documentation/dev-manual/new-recipe.rst
@@ -1401,7 +1401,7 @@ Following Recipe Style Guidelines
1401================================= 1401=================================
1402 1402
1403When writing recipes, it is good to conform to existing style guidelines. 1403When writing recipes, it is good to conform to existing style guidelines.
1404See the ":doc:`../contributor-guide/recipe-style-guide`" in the Yocto Project 1404See the ":doc:`/contributor-guide/recipe-style-guide`" in the Yocto Project
1405and OpenEmbedded Contributor Guide for reference. 1405and OpenEmbedded Contributor Guide for reference.
1406 1406
1407It is common for existing recipes to deviate a bit from this style. 1407It is common for existing recipes to deviate a bit from this style.
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 73548132a3..d77da04276 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -234,7 +234,7 @@ particular working environment and set of practices.
234 - The Yocto Project community encourages you to send patches to the 234 - The Yocto Project community encourages you to send patches to the
235 project to fix bugs or add features. If you do submit patches, 235 project to fix bugs or add features. If you do submit patches,
236 follow the project commit guidelines for writing good commit 236 follow the project commit guidelines for writing good commit
237 messages. See the ":doc:`../contributor-guide/submit-changes`" 237 messages. See the ":doc:`/contributor-guide/submit-changes`"
238 section in the Yocto Project and OpenEmbedded Contributor Guide. 238 section in the Yocto Project and OpenEmbedded Contributor Guide.
239 239
240 - Send changes to the core sooner than later as others are likely 240 - Send changes to the core sooner than later as others are likely
diff --git a/documentation/dev-manual/vulnerabilities.rst b/documentation/dev-manual/vulnerabilities.rst
index d901ff975b..5331a63991 100644
--- a/documentation/dev-manual/vulnerabilities.rst
+++ b/documentation/dev-manual/vulnerabilities.rst
@@ -22,7 +22,7 @@ issues may be impacting Poky and OE-Core. It is up to the maintainers, users,
22contributors and anyone interested in the issues to investigate and possibly fix them by 22contributors and anyone interested in the issues to investigate and possibly fix them by
23updating software components to newer versions or by applying patches to address them. 23updating software components to newer versions or by applying patches to address them.
24It is recommended to work with Poky and OE-Core upstream maintainers and submit 24It is recommended to work with Poky and OE-Core upstream maintainers and submit
25patches to fix them, see ":doc:`../contributor-guide/submit-changes`" for details. 25patches to fix them, see ":doc:`/contributor-guide/submit-changes`" for details.
26 26
27Vulnerability check at build time 27Vulnerability check at build time
28================================= 28=================================
diff --git a/documentation/migration-guides/release-notes-4.3.rst b/documentation/migration-guides/release-notes-4.3.rst
index 0103ac985e..aa3f31a2ce 100644
--- a/documentation/migration-guides/release-notes-4.3.rst
+++ b/documentation/migration-guides/release-notes-4.3.rst
@@ -272,9 +272,9 @@ New Features / Enhancements in 4.3
272 272
273- Prominent documentation updates: 273- Prominent documentation updates:
274 274
275 - New :doc:`../contributor-guide/index` document. 275 - New :doc:`/contributor-guide/index` document.
276 276
277 - New :doc:`../dev-manual/security-subjects` chapter in the Development 277 - New :doc:`/dev-manual/security-subjects` chapter in the Development
278 Tasks Manual. 278 Tasks Manual.
279 279
280 - Long overdue documentation for the :ref:`ref-classes-devicetree` class. 280 - Long overdue documentation for the :ref:`ref-classes-devicetree` class.
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst
index d79173ff55..066d784314 100644
--- a/documentation/overview-manual/development-environment.rst
+++ b/documentation/overview-manual/development-environment.rst
@@ -240,7 +240,7 @@ and so forth.
240 240
241 For information on finding out who is responsible for (maintains) a 241 For information on finding out who is responsible for (maintains) a
242 particular area of code in the Yocto Project, see the 242 particular area of code in the Yocto Project, see the
243 ":doc:`../contributor-guide/identify-component`" 243 ":doc:`/contributor-guide/identify-component`"
244 section of the Yocto Project and OpenEmbedded Contributor Guide. 244 section of the Yocto Project and OpenEmbedded Contributor Guide.
245 245
246The Yocto Project ``poky`` Git repository also has an upstream 246The Yocto Project ``poky`` Git repository also has an upstream
@@ -272,7 +272,7 @@ push them into the "contrib" area and subsequently request that the
272maintainer include them into an upstream branch. This process is called 272maintainer include them into an upstream branch. This process is called
273"submitting a patch" or "submitting a change." For information on 273"submitting a patch" or "submitting a change." For information on
274submitting patches and changes, see the 274submitting patches and changes, see the
275":doc:`../contributor-guide/submit-changes`" section in the Yocto Project 275":doc:`/contributor-guide/submit-changes`" section in the Yocto Project
276and OpenEmbedded Contributor Guide. 276and OpenEmbedded Contributor Guide.
277 277
278In summary, there is a single point of entry for changes into the 278In summary, there is a single point of entry for changes into the
@@ -347,7 +347,7 @@ Book <https://book.git-scm.com>`__.
347 this type of change, you format the patch and then send the email 347 this type of change, you format the patch and then send the email
348 using the Git commands ``git format-patch`` and ``git send-email``. 348 using the Git commands ``git format-patch`` and ``git send-email``.
349 For information on how to use these scripts, see the 349 For information on how to use these scripts, see the
350 ":doc:`../contributor-guide/submit-changes`" section in the Yocto Project 350 ":doc:`/contributor-guide/submit-changes`" section in the Yocto Project
351 and OpenEmbedded Contributor Guide. 351 and OpenEmbedded Contributor Guide.
352 352
353Git 353Git
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
23to the project either by creating and sending pull requests, or by 23to the project either by creating and sending pull requests, or by
24submitting patches through email. For information on how to do both as 24submitting patches through email. For information on how to do both as
25well as information on how to identify the maintainer for each area of 25well as information on how to identify the maintainer for each area of
26code, see the :doc:`../contributor-guide/index`. 26code, see the :doc:`/contributor-guide/index`.
27 27
28.. _resources-bugtracker: 28.. _resources-bugtracker:
29 29
@@ -45,7 +45,7 @@ your expectations).
45For a general procedure and guidelines on how to use Bugzilla to submit a bug 45For a general procedure and guidelines on how to use Bugzilla to submit a bug
46against the Yocto Project, see the following: 46against 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
151Required Packages for the Build Host 151Required 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.
diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst
index 6ff55e5619..a5f55c567a 100644
--- a/documentation/transitioning-to-a-custom-environment.rst
+++ b/documentation/transitioning-to-a-custom-environment.rst
@@ -8,8 +8,8 @@ Transitioning to a custom environment for systems development
8 8
9.. note:: 9.. note::
10 10
11 So you've finished the :doc:`brief-yoctoprojectqs/index` and 11 So you've finished the :doc:`/brief-yoctoprojectqs/index` and
12 glanced over the document :doc:`what-i-wish-id-known`, the latter contains 12 glanced over the document :doc:`/what-i-wish-id-known`, the latter contains
13 important information learned from other users. You're well prepared. But 13 important information learned from other users. You're well prepared. But
14 now, as you are starting your own project, it isn't exactly straightforward what 14 now, as you are starting your own project, it isn't exactly straightforward what
15 to do. And, the documentation is daunting. We've put together a few hints to 15 to do. And, the documentation is daunting. We've put together a few hints to
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst
index 836097910d..ddee6ad749 100644
--- a/documentation/what-i-wish-id-known.rst
+++ b/documentation/what-i-wish-id-known.rst
@@ -49,7 +49,7 @@ contact us with other suggestions.
49 their silicon. These layers have names such as "meta-intel" or "meta-ti". Try 49 their silicon. These layers have names such as "meta-intel" or "meta-ti". Try
50 not to build layers from scratch. If you do have custom silicon, use one of 50 not to build layers from scratch. If you do have custom silicon, use one of
51 these layers as a guide or template and familiarize yourself with the 51 these layers as a guide or template and familiarize yourself with the
52 :doc:`bsp-guide/index`. 52 :doc:`/bsp-guide/index`.
53 53
54#. **Do not put everything into one layer:** 54#. **Do not put everything into one layer:**
55 Use different layers to logically separate information in your build. As an 55 Use different layers to logically separate information in your build. As an
@@ -127,7 +127,7 @@ contact us with other suggestions.
127 You can build and run a specific task for a specific package (including 127 You can build and run a specific task for a specific package (including
128 devshell) or even a single recipe. When developers first start using the 128 devshell) or even a single recipe. When developers first start using the
129 Yocto Project, the instructions found in the 129 Yocto Project, the instructions found in the
130 :doc:`brief-yoctoprojectqs/index` show how to create an image 130 :doc:`/brief-yoctoprojectqs/index` show how to create an image
131 and then run or flash that image. However, you can actually build just a 131 and then run or flash that image. However, you can actually build just a
132 single recipe. Thus, if some dependency or recipe isn't working, you can just 132 single recipe. Thus, if some dependency or recipe isn't working, you can just
133 say "bitbake foo" where "foo" is the name for a specific recipe. As you 133 say "bitbake foo" where "foo" is the name for a specific recipe. As you