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 2/6] ref-manual/variables.rst: add manpage links for toolchain variables
Date: Thu, 27 Mar 2025 10:07:27 +0100 [thread overview]
Message-ID: <20250327-cc-vars-v3-2-742dbddce008@bootlin.com> (raw)
In-Reply-To: <20250327-cc-vars-v3-0-742dbddce008@bootlin.com>
Use the :manpage: role to provide links to common toolchain utilities.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/ref-manual/variables.rst | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 4e675b6bf..d98721818 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -143,7 +143,7 @@ system and gives an overview of their function and contents.
information on how this variable is used.
:term:`AR`
- The minimal command and arguments used to run ``ar``.
+ The minimal command and arguments used to run :manpage:`ar <ar(1)>`.
:term:`ARCHIVER_MODE`
When used with the :ref:`ref-classes-archiver` class,
@@ -165,7 +165,8 @@ system and gives an overview of their function and contents.
``meta/classes/archiver.bbclass`` file in the :term:`Source Directory`.
:term:`AS`
- Minimal command and arguments needed to run the assembler.
+ Minimal command and arguments needed to run the :manpage:`assembler
+ <as(1)>`.
:term:`ASSUME_PROVIDED`
Lists recipe names (:term:`PN` values) BitBake does not
@@ -5165,7 +5166,8 @@ system and gives an overview of their function and contents.
``LAYERVERSION_mylayer``).
:term:`LD`
- The minimal command and arguments used to run the linker.
+ The minimal command and arguments used to run the :manpage:`linker
+ <ld(1)>`.
:term:`LDFLAGS`
Specifies the flags to pass to the linker. This variable is exported
@@ -5771,7 +5773,7 @@ system and gives an overview of their function and contents.
variable is set.
:term:`NM`
- The minimal command and arguments to run ``nm``.
+ The minimal command and arguments to run :manpage:`nm <nm(1)>`.
:term:`NO_GENERIC_LICENSE`
Avoids QA errors when you use a non-common, non-CLOSED license in a
@@ -5860,10 +5862,10 @@ system and gives an overview of their function and contents.
NVDCVE_API_KEY = "fe753&7a2-1427-347d-23ff-b2e2b7ca5f3"
:term:`OBJCOPY`
- The minimal command and arguments to run ``objcopy``.
+ The minimal command and arguments to run :manpage:`objcopy <objcopy(1)>`.
:term:`OBJDUMP`
- The minimal command and arguments to run ``objdump``.
+ The minimal command and arguments to run :manpage:`objdump <objdump(1)>`.
:term:`OE_BINCONFIG_EXTRA_MANGLE`
When inheriting the :ref:`ref-classes-binconfig` class,
@@ -7174,7 +7176,7 @@ system and gives an overview of their function and contents.
QA_EMPTY_DIRS_RECOMMENDATION:/dev = "but all devices must be created at runtime"
:term:`RANLIB`
- The minimal command and arguments to run ``ranlib``.
+ The minimal command and arguments to run :manpage:`ranlib <ranlib(1)>`.
:term:`RCONFLICTS`
The list of packages that conflict with packages. Note that packages
@@ -8914,8 +8916,8 @@ system and gives an overview of their function and contents.
places stamps. The default directory is ``${TMPDIR}/stamps``.
:term:`STRIP`
- The minimal command and arguments to run ``strip``, which is used to
- strip symbols.
+ The minimal command and arguments to run :manpage:`strip <strip(1)>`,
+ which is used to strip symbols.
:term:`SUMMARY`
The short (72 characters or less) summary of the binary package for
--
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 ` [PATCH v3 1/6] documentation/conf.py: define a manpage url Antonin Godard
2025-03-27 15:35 ` [docs] " Mark Hatle
2025-03-31 15:01 ` Antonin Godard
2025-03-28 13:21 ` Quentin Schulz
2025-03-27 9:07 ` Antonin Godard [this message]
2025-03-28 13:23 ` [docs] [PATCH v3 2/6] ref-manual/variables.rst: add manpage links for toolchain variables 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-2-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox