| Message ID | 20250326-cc-vars-v2-1-36b80c64c4a9@bootlin.com |
|---|---|
| State | New |
| Headers | show |
| Series | Document missing toolchain related variables | expand |
Hi Antonin, On 3/26/25 2:21 PM, Antonin Godard via lists.yoctoproject.org wrote: > 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. > > Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> > --- > documentation/conf.py | 3 +++ > documentation/overview-manual/concepts.rst | 2 +- > documentation/overview-manual/yp-intro.rst | 2 +- > 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..0352bbef20 100644 > --- a/documentation/conf.py > +++ b/documentation/conf.py > @@ -111,6 +111,9 @@ extlinks = { > 'wikipedia': ('https://en.wikipedia.org/wiki/%25s', None), > } > > +# To able to use :manpage:`<something>` in the docs. +be > +manpages_url = 'https://manpages.debian.org/{path}' > +> # Intersphinx config to use cross reference with BitBake user manual > intersphinx_mapping = { > '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..25cac82816 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 > root environment does not cause problems. > > 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`", which is derived from Should we pass the section as well, to make sure it'll always point to the same page, regardless of other sections that may appear later on? Otherwise it'll find the first page available, looking from 1 1p 8 2 3 3p 3pm 4 5 6 7 9 0p n l p o 1x 2x 3x 4x 5x 6x 7x 8x (c.f. man 1 man) (same remarks for the other links). Cheers, Quentin
diff --git a/documentation/conf.py b/documentation/conf.py index 477e75112a..0352bbef20 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -111,6 +111,9 @@ extlinks = { 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), } +# To 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_mapping = { '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..25cac82816 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 root environment does not cause problems. 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`", which is derived from the BitBake keyword/variable flag that requests a fake root environment for a task. diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 4a27e12e01..d3037329d3 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst @@ -400,7 +400,7 @@ Yocto Project: Autobuilder :doc:`here </test-manual/understand-autobuilder>`. - *Pseudo:* Pseudo is the Yocto Project implementation of - `fakeroot <http://man.he.net/man1/fakeroot>`__, which is used to run + :manpage:`fakeroot`, which is used to run commands in an environment that seemingly has root privileges. 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 41bda5d0d6..2b31bc7b00 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -4514,8 +4514,7 @@ system and gives an overview of their function and contents. The value in :term:`INITSCRIPT_PARAMS` is passed through to the ``update-rc.d`` command. For more information on valid parameters, - please see the ``update-rc.d`` manual page at - https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html + please see the ``update-rc.d`` manual page at :manpage:`update-rc.d`. :term:`INSANE_SKIP` Specifies the QA checks to skip for a specific package within a
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. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- documentation/conf.py | 3 +++ documentation/overview-manual/concepts.rst | 2 +- documentation/overview-manual/yp-intro.rst | 2 +- documentation/ref-manual/variables.rst | 3 +-- 4 files changed, 6 insertions(+), 4 deletions(-)