summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-03-31 17:04:45 +0200
committerSteve Sakoman <steve@sakoman.com>2025-04-28 08:18:53 -0700
commit5d81e92acdc4aecfe513c7e59a980dc6c7511f52 (patch)
tree24ec80f02e3ccbc5d4bfe947c2bafeb7bbf9f9ef /documentation
parentcb1da2f8257e8df1eeb036ccf186c38780bc50ca (diff)
downloadpoky-5d81e92acdc4aecfe513c7e59a980dc6c7511f52.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: 73faf4a4fdd3d536e8af92b49bf067746cd9fa05) 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: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
-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 b77cb731fb..062ac4ab76 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -2201,7 +2201,7 @@ require root privileges, the fact that some earlier steps ran in a fake
2201root environment does not cause problems. 2201root environment does not cause problems.
2202 2202
2203The capability to run tasks in a fake root environment is known as 2203The capability to run tasks in a fake root environment is known as
2204"`fakeroot <http://man.he.net/man1/fakeroot>`__", which is derived from 2204":manpage:`fakeroot <fakeroot(1)>`", which is derived from
2205the BitBake keyword/variable flag that requests a fake root environment 2205the BitBake keyword/variable flag that requests a fake root environment
2206for a task. 2206for a task.
2207 2207
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 78628005ae..89099a1208 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4383,8 +4383,7 @@ system and gives an overview of their function and contents.
4383 4383
4384 The value in :term:`INITSCRIPT_PARAMS` is passed through to the 4384 The value in :term:`INITSCRIPT_PARAMS` is passed through to the
4385 ``update-rc.d`` command. For more information on valid parameters, 4385 ``update-rc.d`` command. For more information on valid parameters,
4386 please see the ``update-rc.d`` manual page at 4386 please see the manual page: :manpage:`update-rc.d <update-rc.d(8)>`.
4387 https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html
4388 4387
4389 :term:`INSANE_SKIP` 4388 :term:`INSANE_SKIP`
4390 Specifies the QA checks to skip for a specific package within a 4389 Specifies the QA checks to skip for a specific package within a