summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-10-27 11:14:19 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-10-28 15:48:03 +0100
commit4def515eebca300c7ac15c86caef34342dd9ed3d (patch)
tree39b9195513c09ea4bb3763374d20cadf6f2caefa /documentation
parentbb3fc03ef167a005cdf1192df60ac2fb1cbc5ae3 (diff)
downloadpoky-4def515eebca300c7ac15c86caef34342dd9ed3d.tar.gz
manuals: replace "_" by "__" in external links
(From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981) 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/boilerplate.rst2
-rw-r--r--documentation/dev-manual/common-tasks.rst5
-rw-r--r--documentation/ref-manual/classes.rst4
-rw-r--r--documentation/ref-manual/terms.rst6
-rw-r--r--documentation/ref-manual/variables.rst6
-rw-r--r--documentation/test-manual/reproducible-builds.rst2
6 files changed, 12 insertions, 13 deletions
diff --git a/documentation/boilerplate.rst b/documentation/boilerplate.rst
index 9b64d91efd..ad7bb64956 100644
--- a/documentation/boilerplate.rst
+++ b/documentation/boilerplate.rst
@@ -8,7 +8,7 @@
8 8
9Permission is granted to copy, distribute and/or modify this document under the 9Permission is granted to copy, distribute and/or modify this document under the
10terms of the `Creative Commons Attribution-Share Alike 2.0 UK: England & Wales 10terms of the `Creative Commons Attribution-Share Alike 2.0 UK: England & Wales
11<https://creativecommons.org/licenses/by-sa/2.0/uk/>`_ as published by Creative 11<https://creativecommons.org/licenses/by-sa/2.0/uk/>`__ as published by Creative
12Commons. 12Commons.
13 13
14To report any inaccuracies or problems with this (or any other Yocto Project) 14To report any inaccuracies or problems with this (or any other Yocto Project)
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 25d7edbc29..eb1f917012 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -7554,9 +7554,8 @@ NPM packages:
7554- Of the two methods that you can use ``devtool`` to create NPM 7554- Of the two methods that you can use ``devtool`` to create NPM
7555 packages, the registry approach is slightly simpler. However, you 7555 packages, the registry approach is slightly simpler. However, you
7556 might consider the project approach because you do not have to 7556 might consider the project approach because you do not have to
7557 publish your module in the NPM registry 7557 publish your module in the `NPM registry <https://docs.npmjs.com/misc/registry>`__,
7558 (`npm-registry <https://docs.npmjs.com/misc/registry>`_), which 7558 which is NPM's public registry.
7559 is NPM's public registry.
7560 7559
7561- Be familiar with 7560- Be familiar with
7562 :doc:`devtool </ref-manual/devtool-reference>`. 7561 :doc:`devtool </ref-manual/devtool-reference>`.
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index cce0269b9a..e352abc4d8 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1786,7 +1786,7 @@ is supported by ``overlayfs``. This has to be done in your machine configuration
1786 * QA checks fail to catch file existence if you redefine this variable in your recipe! 1786 * QA checks fail to catch file existence if you redefine this variable in your recipe!
1787 * Only the existence of the systemd mount unit file is checked, not its contents. 1787 * Only the existence of the systemd mount unit file is checked, not its contents.
1788 * To get more details on ``overlayfs``, its internals and supported operations, please refer 1788 * To get more details on ``overlayfs``, its internals and supported operations, please refer
1789 to the official documentation of the `Linux kernel <https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html>`_. 1789 to the official documentation of the `Linux kernel <https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html>`__.
1790 1790
1791The class assumes you have a ``data.mount`` systemd unit defined elsewhere in your BSP 1791The class assumes you have a ``data.mount`` systemd unit defined elsewhere in your BSP
1792(e.g. in ``systemd-machine-units`` recipe) and it's installed into the image. 1792(e.g. in ``systemd-machine-units`` recipe) and it's installed into the image.
@@ -2533,7 +2533,7 @@ build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and have
2533not migrated to the official ``pyproject.toml`` format). Unlike 2533not migrated to the official ``pyproject.toml`` format). Unlike
2534``setuptools3.bbclass``, this uses the traditional ``setup.py`` ``build`` and 2534``setuptools3.bbclass``, this uses the traditional ``setup.py`` ``build`` and
2535``install`` commands and not wheels. This use of ``setuptools`` like this is 2535``install`` commands and not wheels. This use of ``setuptools`` like this is
2536`deprecated <https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v5830>`_ 2536`deprecated <https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v5830>`__
2537but still relatively common. 2537but still relatively common.
2538 2538
2539.. _ref-classes-setuptools3-base: 2539.. _ref-classes-setuptools3-base:
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 1e3f718a8f..1a2c055591 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -139,12 +139,12 @@ universal, the list includes them just in case:
139 be included independently in your project's ``bblayers.conf`` file. 139 be included independently in your project's ``bblayers.conf`` file.
140 140
141 In some cases, such as with OpenEmbedded's 141 In some cases, such as with OpenEmbedded's
142 `meta-openembedded <https://github.com/openembedded/meta-openembedded>`_ 142 `meta-openembedded <https://github.com/openembedded/meta-openembedded>`__
143 layer, the top level ``meta-openembedded/`` directory is not itself an actual layer, 143 layer, the top level ``meta-openembedded/`` directory is not itself an actual layer,
144 so you would never explicitly include it in a ``bblayers.conf`` file; 144 so you would never explicitly include it in a ``bblayers.conf`` file;
145 rather, you would include any number of its layer subdirectories, such as 145 rather, you would include any number of its layer subdirectories, such as
146 `meta-openembedded/meta-oe <https://github.com/openembedded/meta-openembedded/tree/master/meta-oe>`_, 146 `meta-openembedded/meta-oe <https://github.com/openembedded/meta-openembedded/tree/master/meta-oe>`__,
147 `meta-openembedded/meta-python <https://github.com/openembedded/meta-openembedded/tree/master/meta-python>`_ 147 `meta-openembedded/meta-python <https://github.com/openembedded/meta-openembedded/tree/master/meta-python>`__
148 and so on. 148 and so on.
149 149
150 On the other hand, some container layers (such as 150 On the other hand, some container layers (such as
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0f9df3ac20..601db6f42f 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -615,7 +615,7 @@ system and gives an overview of their function and contents.
615 software. 615 software.
616 616
617 When specifying recipe files, you can pattern match using Python's 617 When specifying recipe files, you can pattern match using Python's
618 `glob <https://docs.python.org/3/library/glob.html>`_ syntax. 618 `glob <https://docs.python.org/3/library/glob.html>`__ syntax.
619 For details on the syntax, see the documentation by following the 619 For details on the syntax, see the documentation by following the
620 previous link. 620 previous link.
621 621
@@ -2493,7 +2493,7 @@ system and gives an overview of their function and contents.
2493 2493
2494 - When specifying files or paths, you can pattern match using 2494 - When specifying files or paths, you can pattern match using
2495 Python's 2495 Python's
2496 `glob <https://docs.python.org/3/library/glob.html>`_ 2496 `glob <https://docs.python.org/3/library/glob.html>`__
2497 syntax. For details on the syntax, see the documentation by 2497 syntax. For details on the syntax, see the documentation by
2498 following the previous link. 2498 following the previous link.
2499 2499
@@ -4955,7 +4955,7 @@ system and gives an overview of their function and contents.
4955 See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. 4955 See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information.
4956 4956
4957 :term:`module_conf` 4957 :term:`module_conf`
4958 Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`_ 4958 Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`__
4959 syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` 4959 syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf``
4960 file. 4960 file.
4961 4961
diff --git a/documentation/test-manual/reproducible-builds.rst b/documentation/test-manual/reproducible-builds.rst
index 5977366c9e..61127de23c 100644
--- a/documentation/test-manual/reproducible-builds.rst
+++ b/documentation/test-manual/reproducible-builds.rst
@@ -19,7 +19,7 @@ Why it matters
19============== 19==============
20 20
21The project aligns with the `Reproducible Builds project 21The project aligns with the `Reproducible Builds project
22<https://reproducible-builds.org/>`_, which shares information about why 22<https://reproducible-builds.org/>`__, which shares information about why
23reproducibility matters. The primary focus of the project is the ability to 23reproducibility matters. The primary focus of the project is the ability to
24detect security issues being introduced. However, from a Yocto Project 24detect security issues being introduced. However, from a Yocto Project
25perspective, it is also hugely important that our builds are deterministic. When 25perspective, it is also hugely important that our builds are deterministic. When