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/bsp-guide | |
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/bsp-guide')
-rw-r--r-- | documentation/bsp-guide/bsp.rst | 4 |
1 files changed, 2 insertions, 2 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. |