EX-6713 doc: man pages for asynchronous PCCRO attachment

This patch updates the man pages for asynchronous PCCRO attachment
for "lfs pcc attach -A" command.

Change-Id: I7757a9d0b66a3586abdc9053b73d69944561ffbd
Test-Parameters: trivial
Signed-off-by: Qian Yingjin <qian@ddn.com>
Reviewed-on: https://review.whamcloud.com/c/ex/lustre-release/+/49640
Tested-by: jenkins <devops@whamcloud.com>
Tested-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>

diff --git a/lustre/doc/lfs-pcc-attach.1 b/lustre/doc/lfs-pcc-attach.1
index c4c0c63..1a86363 100644 (file)
--- a/lustre/doc/lfs-pcc-attach.1
+++ b/lustre/doc/lfs-pcc-attach.1
@@ -2,9 +2,9 @@
 .SH NAME
 lfs pcc attach \- attach file to local cache filesystem
 .SH SYNOPSIS
-.BR "lfs pcc attach " [ -rw "] [" --id | -i "\fIID\fR] <" \fIFILE ...>
+.BR "lfs pcc attach " [ -rw "] [" --pin|-p "] [" --async|-A "] [" --id | -i " \fIID\fR] <" \fIFILE ...>
 .br
-.BR "lfs pcc attach_fid " [ -rw "] [" --id | -i "\fIID\fR] {" --mnt | -m "\fIMNTPATH\fR} <" \fIFID ...>
+.BR "lfs pcc attach_fid " [ -rw "] [" --pin|-p "] [" --async|-A "] [" --id | -i " \fIID\fR] {" --mnt | -m " \fIMNTPATH\fR} <" \fIFID ...>
 .SH DESCRIPTION
 Attach and copy the specified files into the persistent client cache. Use
 .B lfs pcc detach
@@ -35,12 +35,24 @@ Attach the file in read-write mode.
 .TP
 .BR --pin | -p
 Pin and attach the file so that it will not be detached automatically.
+.TP
+.BR --async | -A
+Optionally, do asynchronous file attach instead of a single-threaded synchronous
+attach. In this case, the application may attach the file without waiting for it
+to be fully copied into PCC backend.
 .SH EXAMPLES
 .TP
 .B $ lfs pcc attach -i 1 /mnt/lustre/file
 Attach an existing file into PCC with archive ID 1 and copy data from Lustre
 to cache device. Reads from the Lustre file will direct to the PCC-RO copy.
 .TP
+.B $ lfs pcc attach -r -i 2 -A /mnt/lustre/file
+Read-only attach a existing file "/mnt/lustre/file" into PCC with archive ID 2
+in a asynchronous way. The attach process does not wait for the attaching file
+to be fully copied into PCC-RO backend. During data copy for attachment, the
+application can read data from Lustre OSTs. After finished data copy, Reads
+will direct to the PCC-RO copy.
+.TP
 .B $ lfs pcc attach_fid -r -m /mnt/lustre 0x200000401:0x1:0x0
 Read-only attach file referenced by FID "0x200000401:0x1:0x0" in filesystem
 .B /mnt/lustre