summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-03-31 17:04:45 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-05-25 12:37:57 +0100
commit7d29579a31501900e10b2cb56c429095c3c7d91a (patch)
tree3f4b8885e4bdad39382db044330b611b89556e2b
parent5377678cf5311e33dca90eeb28a28d39a17f8f3e (diff)
downloadpoky-7d29579a31501900e10b2cb56c429095c3c7d91a.tar.gz
documentation/conf.py: define a manpage url
By defining the manpages_url we can use the :manpage: role in the documentation for providing links to manpages. See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url Replace existing manpages links to use this role. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: f5c964f41ed0f9a9740769e40aabf543df274c03) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/conf.py3
-rw-r--r--documentation/overview-manual/concepts.rst2
-rw-r--r--documentation/overview-manual/yp-intro.rst2
-rw-r--r--documentation/ref-manual/variables.rst3
4 files changed, 6 insertions, 4 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index 477e75112a..2aceeb8e79 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -111,6 +111,9 @@ extlinks = {
111 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), 111 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None),
112} 112}
113 113
114# To be able to use :manpage:`<something>` in the docs.
115manpages_url = 'https://manpages.debian.org/{path}'
116
114# Intersphinx config to use cross reference with BitBake user manual 117# Intersphinx config to use cross reference with BitBake user manual
115intersphinx_mapping = { 118intersphinx_mapping = {
116 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) 119 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None)
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 9ff9785bdd..582e2f7952 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -2204,7 +2204,7 @@ require root privileges, the fact that some earlier steps ran in a fake
2204root environment does not cause problems. 2204root environment does not cause problems.
2205 2205
2206The capability to run tasks in a fake root environment is known as 2206The capability to run tasks in a fake root environment is known as
2207"`fakeroot <http://man.he.net/man1/fakeroot>`__", which is derived from 2207":manpage:`fakeroot <fakeroot(1)>`", which is derived from
2208the BitBake keyword/variable flag that requests a fake root environment 2208the BitBake keyword/variable flag that requests a fake root environment
2209for a task. 2209for a task.
2210 2210
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 4a27e12e01..11e6d99e32 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -400,7 +400,7 @@ Yocto Project:
400 Autobuilder :doc:`here </test-manual/understand-autobuilder>`. 400 Autobuilder :doc:`here </test-manual/understand-autobuilder>`.
401 401
402- *Pseudo:* Pseudo is the Yocto Project implementation of 402- *Pseudo:* Pseudo is the Yocto Project implementation of
403 `fakeroot <http://man.he.net/man1/fakeroot>`__, which is used to run 403 :manpage:`fakeroot <fakeroot(1)>`, which is used to run
404 commands in an environment that seemingly has root privileges. 404 commands in an environment that seemingly has root privileges.
405 405
406 During a build, it can be necessary to perform operations that 406 During a build, it can be necessary to perform operations that
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0939994497..63a094413c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4426,8 +4426,7 @@ system and gives an overview of their function and contents.
4426 4426
4427 The value in :term:`INITSCRIPT_PARAMS` is passed through to the 4427 The value in :term:`INITSCRIPT_PARAMS` is passed through to the
4428 ``update-rc.d`` command. For more information on valid parameters, 4428 ``update-rc.d`` command. For more information on valid parameters,
4429 please see the ``update-rc.d`` manual page at 4429 please see the manual page: :manpage:`update-rc.d <update-rc.d(8)>`.
4430 https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html
4431 4430
4432 :term:`INSANE_SKIP` 4431 :term:`INSANE_SKIP`
4433 Specifies the QA checks to skip for a specific package within a 4432 Specifies the QA checks to skip for a specific package within a