[PATCH v2 1/1] doc: man-page for cls

Heinrich Schuchardt heinrich.schuchardt at canonical.com
Fri Oct 7 20:59:57 CEST 2022


Provide a man-page for the cls command.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
---
v2:
	send the full patch
---
 doc/usage/cmd/cls.rst | 26 ++++++++++++++++++++++++++
 doc/usage/index.rst   |  1 +
 2 files changed, 27 insertions(+)
 create mode 100644 doc/usage/cmd/cls.rst

diff --git a/doc/usage/cmd/cls.rst b/doc/usage/cmd/cls.rst
new file mode 100644
index 0000000000..b5c43e0a2e
--- /dev/null
+++ b/doc/usage/cmd/cls.rst
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+cls command
+===========
+
+Synopsis
+--------
+
+::
+
+    cls
+
+Description
+-----------
+
+The cls command clears the screen.
+
+Configuration
+-------------
+
+The cls command is only available if CONFIG_CMD_CLS=y.
+
+Return value
+------------
+
+The return value $? is 0 (true) on success and 1 (false) on failure.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 0fda121026..d0641105ae 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -32,6 +32,7 @@ Shell commands
    cmd/button
    cmd/bootz
    cmd/cbsysinfo
+   cmd/cls
    cmd/conitrace
    cmd/cyclic
    cmd/dm
-- 
2.37.2



More information about the U-Boot mailing list