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/contributor-guide/submit-changes.rst | |
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/contributor-guide/submit-changes.rst')
-rw-r--r-- | documentation/contributor-guide/submit-changes.rst | 4 |
1 files changed, 2 insertions, 2 deletions
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 | ||
78 | After identifying the component to modify as described in the | 78 | After 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 |
80 | corresponding Git repository. Here is an example for OpenEmbedded-Core:: | 80 | corresponding 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: | |||
872 | https://www.linuxfoundation.org/legal/generative-ai. | 872 | https://www.linuxfoundation.org/legal/generative-ai. |
873 | 873 | ||
874 | All of the existing guidelines in this document are expected to be followed, | 874 | All of the existing guidelines in this document are expected to be followed, |
875 | including in the :doc:`recipe-style-guide`, and contributing the changes with | 875 | including in the :doc:`/contributor-guide/recipe-style-guide`, and contributing the changes with |
876 | additional requirements to the items in section | 876 | additional 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 | ||