LU-11473 doc: add lfs-getsom man page

The Lazy Size on MDT feature added a flag to 'lfs' to allow
users to get the LSOM data. Add the lfs "getsom" flag to the
lfs man page.

Also, make a minor correction to the llsom_sync man page that
corrects the order of the --device flag for changelog_register
and changelog_deregister.

Test-Parameters: trivial
Signed-off-by: James Nunez <jnunez@whamcloud.com>
Change-Id: I9a5acab6de3b7f32eb246c94e9975e30f63f10e1
Reviewed-on: https://review.whamcloud.com/33290
Tested-by: Jenkins
Tested-by: Maloo <hpdd-maloo@intel.com>
Reviewed-by: Yingjin Qian <qian@ddn.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
Reviewed-by: Oleg Drokin <green@whamcloud.com>

diff --git a/lustre/doc/lfs-getsom.1 b/lustre/doc/lfs-getsom.1
new file mode 100644 (file)
index 0000000..64e2164
--- /dev/null
+++ b/lustre/doc/lfs-getsom.1
@@ -0,0 +1,35 @@
+.TH LFS-GETSOM 1 2018-10-04 "Lustre" "lustre Utilities"
+.SH NAME
+lfs getsom \- list file attributes that are stored on an MDS
+.SH SYNOPSIS
+.B lfs getsom
+[\fB\-s\fR | \fB\-b\fR | \fB\-f\fR] <file>
+.SH DESCRIPTION
+This command lists file attributes that are stored on the MDS. It is called
+with the full path and file name for a file on the Lustre file system. If no
+flags are used, then all file attributes stored on the MDS will be shown.
+.SH OPTIONS
+.TP
+.BR \-s\fR
+Only show the size value of the SOM data for a given file.
+.TP
+.BR \-b\fR
+Only show the blocks value of the SOM data for a given file.
+.TP
+.BR \-f\fR
+Only show the flag value of the SOM data for a given file.Valid flags are:
+.br
+0 - Unknown or no SoM data, must get size from OSTs.
+.br
+1 - Known strictly correct, FLR or DoM file (SoM guaranteed).
+.br
+2 - Known stale - was right at some point in the past, but it is known
+(or likely) to be incorrect now (e.g. opened for write).
+.br
+4 - Approximate, may never have been strictly correct, need to sync SOM
+data to achieve eventual consistency.
+.SH AUTHOR
+The \fBlfs getsom\fR command is part of the Lustre filesystem.
+.SH SEE ALSO
+.BR lfs (1),
+.BR llsom_sync (8)

diff --git a/lustre/doc/llsom_sync.8 b/lustre/doc/llsom_sync.8
index 083a848..ba7348e 100644 (file)
--- a/lustre/doc/llsom_sync.8
+++ b/lustre/doc/llsom_sync.8
@@ -64,7 +64,7 @@ performance significantly if thousands of fsync requests are sent.
 
 .TP
 Register a changelog consumer for MDT lustre-MDT0000
 
 .TP
 Register a changelog consumer for MDT lustre-MDT0000

-$ cl_user=$(ssh root@mds01 lctl changelog_register --device lustre-MDT0000 -n)
+$ cl_user=$(ssh root@mds01 lctl --device lustre-MDT0000 changelog_register -n)

 .br
 $ echo $cl_user
 .br
 .br
 $ echo $cl_user
 .br


@@ -82,11 +82,11 @@ $ llsom_sync --mdt=lustre-MDT0000 --user=$cl_user \\
 To deregister the changelog user (e.g. after this example, or if SOM
 updates are no longer needed):
 .br
 To deregister the changelog user (e.g. after this example, or if SOM
 updates are no longer needed):
 .br

-$ ssh root@mds01 lctl changelog_deregister --device lustre-MDT0000 $cl_user
+$ ssh root@mds01 lctl --device lustre-MDT0000 changelog_deregister $cl_user

 
 .SH AUTHOR
 The llsom_sync command is part of the Lustre filesystem.
 
 .SH SEE ALSO
 .BR lustre (7),
 
 .SH AUTHOR
 The llsom_sync command is part of the Lustre filesystem.
 
 .SH SEE ALSO
 .BR lustre (7),

-.BR lctl (8),
+.BR lctl (8)