mail archive of the barebox mailing list
 help / color / mirror / Atom feed
* [PATCH] Documentation: turn more magic variable literals into references
@ 2026-01-07  8:10 Ahmad Fatoum
  2026-01-08 20:56 ` Sascha Hauer
  0 siblings, 1 reply; 2+ messages in thread
From: Ahmad Fatoum @ 2026-01-07  8:10 UTC (permalink / raw)
  To: barebox; +Cc: Ahmad Fatoum

Since the last replacement of magic variables with references, two more
instances have made it into the docs, so switch them over now.

Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/user/booting-linux.rst | 2 +-
 Documentation/user/security.rst      | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst
index 4a765363b182..ed1ec3f68a93 100644
--- a/Documentation/user/booting-linux.rst
+++ b/Documentation/user/booting-linux.rst
@@ -193,7 +193,7 @@ bootloader spec file detected at runtime as described in the next section.
 There is also a number of generic default boot targets available, when
 ``CONFIG_BOOT_DEFAULTS`` is enabled. These expands to a single device at most:
 
-* ``bootsource``: expands to the device barebox booted from
+* :ref:`bootsource <magicvar_bootsource>`: expands to the device barebox booted from
 * ``diskuuid.*``: expands to the device with specified ``*`` diskuuid
 
 For these targets that expand to a single device, a partition can also be specified,
diff --git a/Documentation/user/security.rst b/Documentation/user/security.rst
index 5a23bd83ba65..94184ab8e893 100644
--- a/Documentation/user/security.rst
+++ b/Documentation/user/security.rst
@@ -99,8 +99,8 @@ different compression algorithm.
 The fail-safe alternative is to use a parameter name understood only by the
 initramfs (e.g. ``verity_root=``) in all bootloader scripts. If the
 ``root=$dev`` is fixed up by barebox dynamically, the
-``$global.bootm.root_param`` variable can be used to customize the name of the
-parameter passed to Linux.
+:ref:`global.bootm.root_param <magicvar_global_bootm_root_param>` variable can
+be used to customize the name of the parameter passed to Linux.
 
 Disabling the shell
 ^^^^^^^^^^^^^^^^^^^
-- 
2.47.3




^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2026-01-08 20:57 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2026-01-07  8:10 [PATCH] Documentation: turn more magic variable literals into references Ahmad Fatoum
2026-01-08 20:56 ` Sascha Hauer

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox