[PATCH 1/1] doc: fatinfo man-page

[PATCH 1/1] doc: fatinfo man-page

[Heinrich Schuchardt]

Provide a man-page for the fatinfo command.

The .rst file was lost in patch 15d9694600fe ("doc: fatinfo man-page").

Fixes: 15d9694600fe ("doc: fatinfo man-page")
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 doc/usage/fatinfo.rst | 51 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 doc/usage/fatinfo.rst

diff --git a/doc/usage/fatinfo.rst b/doc/usage/fatinfo.rst
new file mode 100644
index 0000000000..af2eba4344
--- /dev/null
+++ b/doc/usage/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).
--
2.30.2

[PATCH 1/1] doc: fatinfo man-page

[Heinrich Schuchardt]

Am 29. April 2021 18:10:01 MESZ schrieb Simon Glass <sjg@chromium.org>:
>On Sat, 17 Apr 2021 at 11:04, Heinrich Schuchardt <xypron.glpk@gmx.de>
>wrote:
>>
>> Provide a man-page for the fatinfo command.
>
>It seems to provide a link to it, not the actual page.

A follow up patch with the missing file has already been merged.

Thanks for reviewing.

Best regards

Heinrich

>
>>
>> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
>> ---
>>  doc/usage/index.rst | 1 +
>>  1 file changed, 1 insertion(+)
>
>Reviewed-by: Simon Glass <sjg@chromium.org>

[PATCH 1/1] doc: fatinfo man-page

[Simon Glass]

On Sat, 17 Apr 2021 at 11:04, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
>
> Provide a man-page for the fatinfo command.

It seems to provide a link to it, not the actual page.

>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
>  doc/usage/index.rst | 1 +
>  1 file changed, 1 insertion(+)

Reviewed-by: Simon Glass <sjg@chromium.org>

[PATCH 1/1] doc: fatinfo man-page

[Heinrich Schuchardt]

Provide a man-page for the fatinfo command.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 doc/usage/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index d330b14a17..b64cfe444a 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -28,6 +28,7 @@ Shell commands
    exception
    exit
    false
+   fatinfo
    for
    load
    loady
--
2.30.2