From 4def515eebca300c7ac15c86caef34342dd9ed3d Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Thu, 27 Oct 2022 11:14:19 +0200 Subject: manuals: replace "_" by "__" in external links (From yocto-docs rev: 25142cd8121fdd6a8e0524fc8417fc666c498981) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- documentation/boilerplate.rst | 2 +- documentation/dev-manual/common-tasks.rst | 5 ++--- documentation/ref-manual/classes.rst | 4 ++-- documentation/ref-manual/terms.rst | 6 +++--- documentation/ref-manual/variables.rst | 6 +++--- documentation/test-manual/reproducible-builds.rst | 2 +- 6 files changed, 12 insertions(+), 13 deletions(-) (limited to 'documentation') 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 @@ Permission is granted to copy, distribute and/or modify this document under the terms of the `Creative Commons Attribution-Share Alike 2.0 UK: England & Wales -`_ as published by Creative +`__ as published by Creative Commons. To 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: - Of the two methods that you can use ``devtool`` to create NPM packages, the registry approach is slightly simpler. However, you might consider the project approach because you do not have to - publish your module in the NPM registry - (`npm-registry `_), which - is NPM's public registry. + publish your module in the `NPM registry `__, + which is NPM's public registry. - Be familiar with :doc:`devtool `. 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 * QA checks fail to catch file existence if you redefine this variable in your recipe! * Only the existence of the systemd mount unit file is checked, not its contents. * To get more details on ``overlayfs``, its internals and supported operations, please refer - to the official documentation of the `Linux kernel `_. + to the official documentation of the `Linux kernel `__. The class assumes you have a ``data.mount`` systemd unit defined elsewhere in your BSP (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 not migrated to the official ``pyproject.toml`` format). Unlike ``setuptools3.bbclass``, this uses the traditional ``setup.py`` ``build`` and ``install`` commands and not wheels. This use of ``setuptools`` like this is -`deprecated `_ +`deprecated `__ but still relatively common. .. _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: be included independently in your project's ``bblayers.conf`` file. In some cases, such as with OpenEmbedded's - `meta-openembedded `_ + `meta-openembedded `__ layer, the top level ``meta-openembedded/`` directory is not itself an actual layer, so you would never explicitly include it in a ``bblayers.conf`` file; rather, you would include any number of its layer subdirectories, such as - `meta-openembedded/meta-oe `_, - `meta-openembedded/meta-python `_ + `meta-openembedded/meta-oe `__, + `meta-openembedded/meta-python `__ and so on. 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. software. When specifying recipe files, you can pattern match using Python's - `glob `_ syntax. + `glob `__ syntax. For details on the syntax, see the documentation by following the previous link. @@ -2493,7 +2493,7 @@ system and gives an overview of their function and contents. - When specifying files or paths, you can pattern match using Python's - `glob `_ + `glob `__ syntax. For details on the syntax, see the documentation by following the previous link. @@ -4955,7 +4955,7 @@ system and gives an overview of their function and contents. See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. :term:`module_conf` - Specifies `modprobe.d `_ + Specifies `modprobe.d `__ syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` file. 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 ============== The project aligns with the `Reproducible Builds project -`_, which shares information about why +`__, which shares information about why reproducibility matters. The primary focus of the project is the ability to detect security issues being introduced. However, from a Yocto Project perspective, it is also hugely important that our builds are deterministic. When -- cgit v1.2.3-54-g00ecf