[PATCH 1/1] doc: describe the false command

Heinrich Schuchardt xypron.glpk at gmx.de
Sun Jan 24 22:13:10 CET 2021


Provide a man-page for the false command.

Signed-off-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
---
 doc/usage/false.rst | 28 ++++++++++++++++++++++++++++
 doc/usage/index.rst |  1 +
 2 files changed, 29 insertions(+)
 create mode 100644 doc/usage/false.rst

diff --git a/doc/usage/false.rst b/doc/usage/false.rst
new file mode 100644
index 0000000000..5f8ed7150d
--- /dev/null
+++ b/doc/usage/false.rst
@@ -0,0 +1,28 @@
+false command
+=============
+
+Synopsis
+--------
+
+::
+
+    false
+
+Description
+-----------
+
+The false command sets the return value $? to 1 (false).
+
+Example
+--------
+
+::
+
+    => false; echo $?
+    1
+    =>
+
+Configuration
+-------------
+
+The false command is only available if CONFIG_HUSH_PARSER=y.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index d3abf2d88a..0309abf2ff 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -19,6 +19,7 @@ Shell commands
    button
    echo
    exit
+   false
    for
    loady
    mbr
--
2.29.2



More information about the U-Boot mailing list