u-boot/doc/usage/cmd/size.rst
Heinrich Schuchardt 60971e63e6 doc: create index entries for commands
Add the description of CLI commands to the generated index.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-01-17 08:40:19 +01:00

43 lines
740 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+
.. index::
single: size (command)
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.