diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-02-08 21:31:16 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-02-10 11:03:36 +0000 |
commit | 5b02cfb3e7b83f3cdf5b4971dd91d5a08f930467 (patch) | |
tree | bafb260cc4b711568d133d9dc3ede27b11b722d8 /documentation | |
parent | 76eae5037000492dc18f12fea2c34ccb45ea8352 (diff) | |
download | poky-5b02cfb3e7b83f3cdf5b4971dd91d5a08f930467.tar.gz |
manuals: replace unnecessary uses of 'yocto_docs' by internal references
These :yocto_docs: references were making external references
to another section of the manual, using the https://docs.yoctoproject.org
website. It's actually better to use internal references (:doc: for an
entire document, and :ref: for a specific section, as they will cause
an error in Sphinx if one day they are no longer valid.
(From yocto-docs rev: 0beff9dea986a2ea4b496180b29a99490416eeeb)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/resources.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 2 | ||||
-rw-r--r-- | documentation/test-manual/reproducible-builds.rst | 4 |
3 files changed, 4 insertions, 4 deletions
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 5a09909c70..d2344e39a0 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst | |||
@@ -173,7 +173,7 @@ Here is a list of resources you might find helpful: | |||
173 | - :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked | 173 | - :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked |
174 | questions and their answers. | 174 | questions and their answers. |
175 | 175 | ||
176 | - :yocto_docs:`Release Information </migration-guides/>`: | 176 | - :doc:`Release Information </migration-guides/index>`: |
177 | Migration guides, release notes, new features, updates and known issues | 177 | Migration guides, release notes, new features, updates and known issues |
178 | for the current and past releases of the Yocto Project. | 178 | for the current and past releases of the Yocto Project. |
179 | 179 | ||
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 1989bd6206..a36c4c6df9 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -8481,7 +8481,7 @@ system and gives an overview of their function and contents. | |||
8481 | responsibility to ensure that the toolchain is compatible with the | 8481 | responsibility to ensure that the toolchain is compatible with the |
8482 | default toolchain. Using older or newer versions of these | 8482 | default toolchain. Using older or newer versions of these |
8483 | components might cause build problems. See | 8483 | components might cause build problems. See |
8484 | :yocto_docs:`Release Information </migration-guides/>` for your | 8484 | :doc:`Release Information </migration-guides/index>` for your |
8485 | version of the Yocto Project, to find the specific components with | 8485 | version of the Yocto Project, to find the specific components with |
8486 | which the toolchain must be compatible. | 8486 | which the toolchain must be compatible. |
8487 | 8487 | ||
diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst index 2a2f7790d2..50256fb197 100644 --- a/documentation/test-manual/reproducible-builds.rst +++ b/documentation/test-manual/reproducible-builds.rst | |||
@@ -24,8 +24,8 @@ reproducibility matters. The primary focus of the project is the ability to | |||
24 | detect security issues being introduced. However, from a Yocto Project | 24 | detect security issues being introduced. However, from a Yocto Project |
25 | perspective, it is also hugely important that our builds are deterministic. When | 25 | perspective, it is also hugely important that our builds are deterministic. When |
26 | you build a given input set of metadata, we expect you to get consistent output. | 26 | you build a given input set of metadata, we expect you to get consistent output. |
27 | This has always been a key focus but, :yocto_docs:`since release 3.1 ("dunfell") | 27 | This has always been a key focus but, :ref:`since release 3.1 ("dunfell") |
28 | </ref-manual/migration-3.1.html#reproducible-builds-now-enabled-by-default>`, | 28 | <migration-guides/migration-3.1:reproducible builds now enabled by default>`, |
29 | it is now true down to the binary level including timestamps. | 29 | it is now true down to the binary level including timestamps. |
30 | 30 | ||
31 | For example, at some point in the future life of a product, you find that you | 31 | For example, at some point in the future life of a product, you find that you |