MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 21:09:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

documentation/conf.py: define a manpage url

Browse Source 
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>
This commit is contained in:
Antonin Godard 2025-03-31 17:04:45 +02:00 committed by Richard Purdie
parent f5e4278fad
commit 5f74fee3b8
4 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
documentation/conf.py
View File

@ -111,6 +111,9 @@ extlinks = {
'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None),
} }
# To be able to use :manpage:`<something>` in the docs.
manpages_url = 'https://manpages.debian.org/{path}'
# Intersphinx config to use cross reference with BitBake user manual # Intersphinx config to use cross reference with BitBake user manual
intersphinx_mapping = { intersphinx_mapping = {
'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None) 'bitbake': ('https://docs.yoctoproject.org/bitbake/' + bitbake_version, None)

2
documentation/overview-manual/concepts.rst
View File

@ -2204,7 +2204,7 @@ require root privileges, the fact that some earlier steps ran in a fake
root environment does not cause problems. root environment does not cause problems.
The capability to run tasks in a fake root environment is known as The capability to run tasks in a fake root environment is known as
"`fakeroot <http://man.he.net/man1/fakeroot>`__", which is derived from ":manpage:`fakeroot <fakeroot(1)>`", which is derived from
the BitBake keyword/variable flag that requests a fake root environment the BitBake keyword/variable flag that requests a fake root environment
for a task. for a task.

2
documentation/overview-manual/yp-intro.rst
View File

@ -400,7 +400,7 @@ Yocto Project:
Autobuilder :doc:`here </test-manual/understand-autobuilder>`. Autobuilder :doc:`here </test-manual/understand-autobuilder>`.
- *Pseudo:* Pseudo is the Yocto Project implementation of - *Pseudo:* Pseudo is the Yocto Project implementation of
`fakeroot <http://man.he.net/man1/fakeroot>`__, which is used to run :manpage:`fakeroot <fakeroot(1)>`, which is used to run
commands in an environment that seemingly has root privileges. commands in an environment that seemingly has root privileges.
During a build, it can be necessary to perform operations that During a build, it can be necessary to perform operations that

3
documentation/ref-manual/variables.rst
View File

@ -4539,8 +4539,7 @@ system and gives an overview of their function and contents.
The value in :term:`INITSCRIPT_PARAMS` is passed through to the The value in :term:`INITSCRIPT_PARAMS` is passed through to the
``update-rc.d`` command. For more information on valid parameters, ``update-rc.d`` command. For more information on valid parameters,
please see the ``update-rc.d`` manual page at please see the manual page: :manpage:`update-rc.d <update-rc.d(8)>`.
https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html
:term:`INSANE_SKIP` :term:`INSANE_SKIP`
Specifies the QA checks to skip for a specific package within a Specifies the QA checks to skip for a specific package within a