From 68cc8ca780c01b8c2ac6d5ed2d19064a967623c3 Mon Sep 17 00:00:00 2001
From: mulhern <amulhern@redhat.com>
Date: Wed, 11 Sep 2024 15:58:52 -0400
Subject: [PATCH] Add list of fields in filesystem detail view
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Belongs with https://github.com/stratis-storage/stratis-cli/pull/1051

Looks like:

       FIELDS for stratis filesystem list [(--uuid <uuid> |--name <name>)]

       UUID
           The UUID of the filesystem.

       Name
           The name of the filesystem.

       Pool
           The name of the filesystem’s pool.

       Device
           The device path to use for mounting the filesystem.

       Created
           The time the filesystem was created.

       Snapshot origin
           If this filesystem is a snapshot, its origin.

       Sizes
           The logical size of the Stratis filesystem, the total space
           actually used, and the logical amount free on the Stratis
           filesystem. Since every Stratis filesystem holds an XFS filesystem,
           a new Stratis filesystem will have a non-zero amount used for the
           XFS filesystem metadata.

Signed-off-by: mulhern <amulhern@redhat.com>
(cherry picked from commit 799c7910d6a16327fbaec00a5dcf0bf42b54b770)
---
 docs/stratis.txt | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/docs/stratis.txt b/docs/stratis.txt
index 047965b43..79fd7f535 100644
--- a/docs/stratis.txt
+++ b/docs/stratis.txt
@@ -325,6 +325,34 @@ UUID::
 	  The UUID of the filesystem.
 
 
+FIELDS for stratis filesystem list [(--uuid <uuid> |--name <name>)]
+
+UUID::
+	The UUID of the filesystem.
+
+Name::
+	The name of the filesystem.
+
+Pool::
+	The name of the filesystem's pool.
+
+Device::
+	The device path to use for mounting the filesystem.
+
+Created::
+	The time the filesystem was created.
+
+Snapshot origin::
+	If this filesystem is a snapshot, its origin.
+
+Sizes::
+	The logical size of the Stratis filesystem, the total space actually
+	used, and the logical amount free on the Stratis filesystem. Since
+	every Stratis filesystem holds an XFS filesystem, a new Stratis
+	filesystem will have a non-zero amount used for the XFS filesystem
+	metadata.
+
+
 FIELDS for stratis blockdev list
 
 Pool Name::