From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
Antonin Godard <antonin.godard@bootlin.com>
Subject: [PATCH v3 1/6] documentation/conf.py: define a manpage url
Date: Thu, 27 Mar 2025 10:07:26 +0100 [thread overview]
Message-ID: <20250327-cc-vars-v3-1-742dbddce008@bootlin.com> (raw)
In-Reply-To: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com>
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 | 4 ++--
4 files changed, 7 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/%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..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
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 <fakeroot(1)>`", 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..11e6d99e32 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 <fakeroot(1)>`, 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..4e675b6bfb 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -4514,8 +4514,8 @@ 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
+ <update-rc.d(8)>`.
:term:`INSANE_SKIP`
Specifies the QA checks to skip for a specific package within a
--
2.47.0
next prev parent reply other threads:[~2025-03-27 9:07 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-27 9:07 [PATCH v3 0/6] Document missing toolchain related variables Antonin Godard
2025-03-27 9:07 ` Antonin Godard [this message]
2025-03-27 15:35 ` [docs] [PATCH v3 1/6] documentation/conf.py: define a manpage url Mark Hatle
2025-03-31 15:01 ` Antonin Godard
2025-03-28 13:21 ` Quentin Schulz
2025-03-27 9:07 ` [PATCH v3 2/6] ref-manual/variables.rst: add manpage links for toolchain variables Antonin Godard
2025-03-28 13:23 ` [docs] " Quentin Schulz
2025-03-27 9:07 ` [PATCH v3 3/6] ref-manual/variables.rst: add missing documentation for BUILD_* variables Antonin Godard
2025-03-28 13:43 ` [docs] " Quentin Schulz
2025-03-27 9:07 ` [PATCH v3 4/6] ref-manual/variables.rst: document missing SDK_*_ARCH variables Antonin Godard
2025-03-27 9:07 ` [PATCH v3 5/6] ref-manual/variables.rst: document HOST_*_ARCH variables Antonin Godard
2025-03-27 9:07 ` [PATCH v3 6/6] ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK reference Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250327-cc-vars-v3-1-742dbddce008@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=thomas.petazzoni@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.