diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2025-03-31 17:04:45 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-04-03 16:28:34 +0100 |
commit | 5f74fee3b86aff1678610fb1a46432a3b6dc923a (patch) | |
tree | 19d232337fe7ce4cbcdf2d2dd0c238e17100c44c /documentation | |
parent | f5e4278fadc5f40f26c584521bb4a30a3f873ded (diff) | |
download | poky-5f74fee3b86aff1678610fb1a46432a3b6dc923a.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: 0d0115cb2d96960837678f775cf5c2297494c51c)
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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/conf.py | 3 | ||||
-rw-r--r-- | documentation/overview-manual/concepts.rst | 2 | ||||
-rw-r--r-- | documentation/overview-manual/yp-intro.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 3 |
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. | ||
115 | manpages_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 |
115 | intersphinx_mapping = { | 118 | intersphinx_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 e4d806f98f..416c28f0d9 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 | |||
2204 | root environment does not cause problems. | 2204 | root environment does not cause problems. |
2205 | 2205 | ||
2206 | The capability to run tasks in a fake root environment is known as | 2206 | The 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 |
2208 | the BitBake keyword/variable flag that requests a fake root environment | 2208 | the BitBake keyword/variable flag that requests a fake root environment |
2209 | for a task. | 2209 | for 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 794440b9fd..417331c6a6 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -4539,8 +4539,7 @@ system and gives an overview of their function and contents. | |||
4539 | 4539 | ||
4540 | The value in :term:`INITSCRIPT_PARAMS` is passed through to the | 4540 | The value in :term:`INITSCRIPT_PARAMS` is passed through to the |
4541 | ``update-rc.d`` command. For more information on valid parameters, | 4541 | ``update-rc.d`` command. For more information on valid parameters, |
4542 | please see the ``update-rc.d`` manual page at | 4542 | please see the manual page: :manpage:`update-rc.d <update-rc.d(8)>`. |
4543 | https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html | ||
4544 | 4543 | ||
4545 | :term:`INSANE_SKIP` | 4544 | :term:`INSANE_SKIP` |
4546 | Specifies the QA checks to skip for a specific package within a | 4545 | Specifies the QA checks to skip for a specific package within a |