[PATCH 1/1] doc: man-page for size command

Heinrich Schuchardt xypron.glpk at gmx.de
Sat May 15 13:10:04 CEST 2021


Provide a man-page for the size command.

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

diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 528b3c745e..6f45fd3878 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -38,6 +38,7 @@ Shell commands
    pstore
    qfw
    sbi
+   size
    true
    scp03
    reset
diff --git a/doc/usage/size.rst b/doc/usage/size.rst
new file mode 100644
index 0000000000..f0c35e4826
--- /dev/null
+++ b/doc/usage/size.rst
@@ -0,0 +1,40 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+size command
+============
+
+Synopsis
+--------
+
+::
+
+    size <interface> <dev[:part]> <filename>
+
+Description
+-----------
+
+The size command determines the size of a file and sets the environment variable
+filesize to this value. If filename points to a directory, the value is set to
+zero.
+
+If the command fails, the filesize environment variable is not changed.
+
+dev
+    device number
+
+part
+    partition number, defaults to 1
+
+filename
+    path to file
+
+Configuration
+-------------
+
+The size command is only available if CONFIG_CMD_FS_GENERIC=y.
+
+Return value
+------------
+
+The return value $? is set to 0 (true) if the command succeded and to 1 (false)
+otherwise.
--
2.30.2



More information about the U-Boot mailing list