summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-11-14 12:30:58 +0300
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-11-16 10:34:06 +0300
commit5727f922ca26b94db38c498935b0b3b75e3cbc4c (patch)
treec2b41e85b7a5440fa34ac767d5a1cca5b5af1776 /doc
parentdd706c83beb1f65f00aed432376cc507ff255fcb (diff)
downloadu-boot-5727f922ca26b94db38c498935b0b3b75e3cbc4c.tar.xz
Documentation: man-page for command bootd
Provide a man-page for the bootd command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/usage/cmd/bootd.rst38
-rw-r--r--doc/usage/index.rst1
2 files changed, 39 insertions, 0 deletions
diff --git a/doc/usage/cmd/bootd.rst b/doc/usage/cmd/bootd.rst
new file mode 100644
index 0000000000..380ef15283
--- /dev/null
+++ b/doc/usage/cmd/bootd.rst
@@ -0,0 +1,38 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+bootd command
+=============
+
+Synopsis
+--------
+
+::
+
+ bootd
+
+Description
+-----------
+
+The bootd command executes the command stored in the environment variable
+*bootcmd*, i.e. it does the same thing as *run bootcmd*.
+
+Example
+-------
+
+::
+
+ => setenv bootcmd 'echo Hello World'
+ => bootd
+ Hello World
+ => setenv bootcmd true
+ => bootd; echo $?
+ 0
+ => setenv bootcmd false
+ => bootd; echo $?
+ 1
+
+Return value
+------------
+
+The return value $? of the bootd command is the return value of the command in
+the environment variable *bootcmd*.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index f7f03aeac1..815b032247 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -23,6 +23,7 @@ Shell commands
cmd/addrmap
cmd/askenv
cmd/base
+ cmd/bootd
cmd/bootdev
cmd/bootefi
cmd/bootflow