summaryrefslogtreecommitdiff
path: root/doc/usage/cmd/fatinfo.rst
diff options
context:
space:
mode:
authorBin Meng <bmeng.cn@gmail.com>2022-03-28 06:02:56 +0300
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-03-31 20:06:16 +0300
commit34e452dd0252c162242a718ed5287a2af622b7d7 (patch)
treea8a179f5b78f829947fdd67ec0f6b685dff46780 /doc/usage/cmd/fatinfo.rst
parent572934d15a67ce5643472b5f6d3151476cc2b89d (diff)
downloadu-boot-34e452dd0252c162242a718ed5287a2af622b7d7.tar.xz
doc: usage: Group all shell command docs into cmd/ sub-directory
Currently all shell command docs are put in the doc/usage root. Let's group them into cmd/ sub-directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Diffstat (limited to 'doc/usage/cmd/fatinfo.rst')
-rw-r--r--doc/usage/cmd/fatinfo.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/usage/cmd/fatinfo.rst b/doc/usage/cmd/fatinfo.rst
new file mode 100644
index 0000000000..af2eba4344
--- /dev/null
+++ b/doc/usage/cmd/fatinfo.rst
@@ -0,0 +1,51 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+fatinfo command
+===============
+
+Synopsis
+--------
+
+::
+
+ fatinfo <interface> <dev[:part]>
+
+Description
+-----------
+
+The fatinfo command displays information about a FAT partition.
+
+interface
+ interface for accessing the block device (mmc, sata, scsi, usb, ....)
+
+dev
+ device number
+
+part
+ partition number, defaults to 1
+
+Example
+-------
+
+Here is the output for a partition on a 32 GB SD-Card:
+
+::
+
+ => fatinfo mmc 0:1
+ Interface: MMC
+ Device 0: Vendor: Man 00001b Snr 97560602 Rev: 13.8 Prod: EB1QT0
+ Type: Removable Hard Disk
+ Capacity: 30528.0 MB = 29.8 GB (62521344 x 512)
+ Filesystem: FAT32 "MYDISK "
+ =>
+
+Configuration
+-------------
+
+The fatinfo command is only available if CONFIG_CMD_FAT=y.
+
+Return value
+------------
+
+The return value $? is set to 0 (true) if the partition is a FAT partition.
+Otherwise it is set to 1 (false).