Whamcloud - gitweb
EX-4006 doc: further improvements to lfs-pcc man pages
authorAndreas Dilger <adilger@whamcloud.com>
Wed, 13 Oct 2021 06:11:18 +0000 (00:11 -0600)
committerAndreas Dilger <adilger@whamcloud.com>
Sat, 30 Oct 2021 06:01:51 +0000 (06:01 +0000)
Describe fields in lfs-pcc-state.1.  Add lfs-pcc-delete.1 page.

Test-Parameters: trivial
Signed-off-by: Andreas Dilger <adilger@whamcloud.com>
Change-Id: I0c165c12e674af0edbb5e84c2e5f8aeed73ebbe5
Reviewed-on: https://review.whamcloud.com/45338
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Maloo <maloo@whamcloud.com>
Reviewed-by: Feng, Lei <flei@whamcloud.com>
Reviewed-by: Yingjin Qian <qian@ddn.com>
lustre/doc/lfs-pcc-delete.1 [new file with mode: 0644]
lustre/doc/lfs-pcc-state.1

diff --git a/lustre/doc/lfs-pcc-delete.1 b/lustre/doc/lfs-pcc-delete.1
new file mode 100644 (file)
index 0000000..b9cec67
--- /dev/null
@@ -0,0 +1,17 @@
+.TH LFS-PCC-DELETE 1 2019-04-15 "Lustre" "Lustre Utilities"
+.SH NAME
+lfs pcc delete \- delete PCC component from file
+.SH SYNOPSIS
+.BR "lfs pcc delete" < \fIFILE ...>
+.SH DESCRIPTION
+Delete PCC component from specified
+.IR FILE (s).
+This will remove the cached file from all connected clients, and
+allow the file to be accessed by older clients that do not have
+PCC support.
+.SH SEE ALSO
+.BR lfs (1),
+.BR lfs-pcc (1),
+.BR lfs-pcc-attach (1),
+.BR lfs-pcc-detach (1),
+.BR lctl-pcc (8)
index a3d0159..f3ee271 100644 (file)
@@ -6,20 +6,29 @@ lfs pcc state \- display current PCC state of file
 .SH DESCRIPTION
 Display the current PCC cache state of
 .I FILE
-.B lfs pcc detach
-to remove the cached files from PCC either manually, or through automatic
-mechanisms for the purpose of the cache space management.
+on the local client.
+This shows several fields for each file.  The cache attach
+.B type
+is one of
+.BR none ,
+.BR readonly ,
+or
+.BR readwrite .
+The
+.B PCC_file
+shows relative pathname of the file within the local cache filesystem.
+The
+.B open_count
+is the number of processes that have the local cache file open, and
+.B flags
+shows additional file states, including
+.B attaching
+for files that are not fully copied into cache,
 .SH EXAMPLES
 .TP
 .B $ lfs pcc state /mnt/lustre/file
 Show the PCC cache state of
 .BR file .
-This shows the cache attach type:
-as
-.BR none ,
-.BR readonly ,
-or
-.BR readwrite .
 .TP
 .SH SEE ALSO
 .BR lfs (1),