grub-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 2/2] docs: document fdtdump command


From: Tobias Heider
Subject: [PATCH 2/2] docs: document fdtdump command
Date: Wed, 12 Jun 2024 13:12:29 +0200

Signed-off-by: Tobias Heider <tobias.heider@canonical.com>
---
 docs/grub.texi | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/grub.texi b/docs/grub.texi
index f3bdc2564..a050dc0fc 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -4373,6 +4373,7 @@ you forget a command, you can run the command 
@command{help}
 * eval::                        Evaluate agruments as GRUB commands
 * export::                      Export an environment variable
 * false::                       Do nothing, unsuccessfully
+* fdtdump::                     Retrieve device tree information
 * fwsetup::                     Reboot into the firmware setup menu
 * gdbinfo::                     Provide info for debugging with GDB
 * gettext::                     Translate a string
@@ -4904,6 +4905,31 @@ such as @code{if} and @code{while} (@pxref{Shell-like 
scripting}).
 @end deffn
 
 
+@node fdtdump
+@subsection fdtdump
+
+@deffn Command fdtdump @
+ [@option{--prop} @var{prop}] @
+ [@option{--set} @var{variable}]
+Retrieve device tree information.
+
+The @command{fdtdump} command returns the value of a property in the device
+tree provided by the firmware.  The @option{--prop} option determines which
+property to select.
+
+The default action is to print the value of the requested field to the console,
+but a variable name can be specified with @option{--set} to store the value
+instead of printing it.
+
+For example, this will store and then display the model string.
+
+@example
+fdtdump --prop model --set machine_model
+echo $machine_model
+@end example
+@end deffn
+
+
 @node fwsetup
 @subsection fwsetup
 
-- 
2.43.0




reply via email to

[Prev in Thread] Current Thread [Next in Thread]