Whamcloud - gitweb
LU-18110 doc: improve wording in lctl-snapshot* manpages 56/55956/4
authorOleg Drokin <green@whamcloud.com>
Wed, 7 Aug 2024 21:41:38 +0000 (17:41 -0400)
committerOleg Drokin <green@whamcloud.com>
Thu, 8 Aug 2024 15:04:46 +0000 (15:04 +0000)
There's some consistently strangely spelled umount when the unmount
action is meant (i.e. not part of the command itself) and other
clearing of the language

Test-Parameters: trivial
Change-Id: If20bcad739e3eb1367f2e028ac45d60d2986fc34
Signed-off-by: Oleg Drokin <green@whamcloud.com>
Reviewed-on: https://review.whamcloud.com/c/fs/lustre-release/+/55956
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
lustre/doc/lctl-snapshot-create.8
lustre/doc/lctl-snapshot-destroy.8
lustre/doc/lctl-snapshot-list.8
lustre/doc/lctl-snapshot-mount.8

index 7f4053d..f2a5a27 100644 (file)
@@ -25,7 +25,7 @@ If you are confident about the system consistency, or not require the full
 consistency and want to avoid blocking applications when creating the snapshot,
 then you can specify barrier
 .BR off .
-That will save your time of creating the snapshot. If the barrier is
+That will save time when creating the snapshot. If the barrier is
 .IR on ,
 then the timeout of the barrier can be specified via
 .B -t
index 5c49ddd..b49e21d 100644 (file)
@@ -20,9 +20,9 @@ section. Then,  the snapshot pieces are destroyed on every Lustre target
 .BR -f ", " --force
 Destroy the specified snapshot by force. If the snapshot is mounted (see
 .BR snapshot_mount ),
-it will be umounted firstly, then destroyed. Even if some pieces of the
-snapshot are lost or broken for some reason(s), the remained parts of the
-snapshot still can be destroyed with this option specified.
+it will be unmounted first and then destroyed. Even if some pieces of the
+snapshot are lost or broken for some reason(s), the remaining parts of the
+snapshot can still be destroyed with this option specified.
 .TP
 .BR  -F ", " --fsname " "\fIfsname
 The filesystem name.
index 06a0f94..643a160 100644 (file)
@@ -8,7 +8,8 @@ lctl-snapshot_list \- query Lustre snapshot
 .br
 .SH DESCRIPTION
 Query the snapshot information, such as fsname of the snapshot, comment,
-create time, the latest modification time, whether mounted or not, and so on.
+create time, the latest modification time, including mount status
+and other details.
 .SH OPTIONS
 .TP
 .BR  -d ", " --detail
index 82719f2..7924e9d 100644 (file)
@@ -7,10 +7,10 @@ lctl-snapshot_mount \- mount Lustre snapshot
              {-n | --name ssname} [-r | --rsh remote_shell]
 .br
 .SH DESCRIPTION
-Mount the specified snapshot on the servers. Since it is a read-only mode
-Lustre filesystem, if the snapshot is mounted, then it cannot be renamed.
-It is the user's duty to mount client (must as read only mode with "-o ro")
-to the snapshot when needed.
+Mount the specified snapshot on the servers. As a read-only filesystem,
+mounted snapshots cannot be renamed.
+It is the user's duty to mount client (must be mounted in read-only mode
+with "-o ro") to the snapshot when needed.
 .B NOTE:
 the snapshot has its own fsname that is different from the original
 filesystem fsname, it can be queried via