LU-4955 lfsck: reset param when the LFSCK is reset

[fs/lustre-release.git] / lustre / doc / lctl.8

diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8
index a9bc9a0..466ad3c 100644 (file)
--- a/lustre/doc/lctl.8
+++ b/lustre/doc/lctl.8
@@ -299,21 +299,27 @@ next minimum.
 An on-line Lustre consistency check and repair tool.
 .TP
 .B lfsck_start \fR<-M | --device [MDT,OST]_device>
-     \fR[-e | --error <error_handle>]
-     \fR[-h | --help]
-     \fR[-n | --dryrun <switch>]
-     \fR[-r | --reset]
-     \fR[-s | --speed <speed_limit>]
-     \fR[-A | --all]
-     \fR[-t | --type <lfsck_type[,lfsck_type...]>]
-     \fR[-w | --windows <win_size>]
-     \fR[-o | --orphan]
+     \fR[-A | --all] [-c | --create_ostobj [on | off]]
+     \fR[-e | --error <continue | abort>] [-h | --help]
+     \fR[-n | --dryrun [on | off]] [-o | --orphan]
+     \fR[-r | --reset] [-s | --speed speed_limit]
+     \fR[-t | --type lfsck_type[,lfsck_type...]]
+     \fR[-w | --window_size size]
 .br
 Start LFSCK on the specified MDT or OST device with specified parameters.
 .TP
   -M, --device <MDT,OST_device>
 The MDT or OST device to start LFSCK/scrub on.
 .TP
+  -A, --all
+Start LFSCK on all MDT devices.
+.TP
+  -c, --create_ostobj [on | off]
+Create the lost OST-object for dangling LOV EA: 'off'(default) or 'on'. Under
+default mode, when the LFSCK find some MDT-object with dangling reference, it
+will report the inconsistency but without repairing. Otherwise the LFSCK will
+re-create the missed OST-object.
+.TP
   -e, --error <error_handle>
 With error_handle as 'abort' LFSCK will stop if a repair is impossible. If no
 value is specified, the saved value will be used if resuming from a checkpoint.
@@ -322,22 +328,23 @@ Otherwise the default behavior is to 'continue' if a repair is impossible.
   -h, --help
 Show this help.
 .TP
-  -n, --dryrun <on|off>
+  -n, --dryrun [on | off]
 Perform a trial run with no changes made. Default is 'off'
 .TP
+  -o, --orphan
+Handle orphan objects, such as orphan OST-objects for layout LFSCK.
+.TP
   -r, --reset
 Set the current position of object iteration to the beginning of the specified
-MDT. By default the iterator will resume scanning from the last checkpoint
-(saved periodically by LFSCK) provided it is available.
+device. The non-specified parameters will also be reset as default. By default
+the iterator will resume the scanning from the last checkpoint (position), and
+other non-specified parameters will be the same as former non-completed run.
 .TP
   -s, --speed <speed_limit>
 Set the upper limit of LFSCK processing in objects per second. If no value is
 specified the saved value is used (if resuming from a check point). Otherwise
 the default value of 0 is used. 0 means run as fast as possible.
 .TP
-  -A, --all
-Start LFSCK on all devices.
-.TP
   -t, --type <lfsck_type[,lfsck_type...]>
 The type of LFSCK checking/repair to execute. By default, the LFSCK
 component(s) which ran last time and did not finish or the component(s)
@@ -346,15 +353,10 @@ LFSCK is triggered on an ldiskfs MDT or OST, the OI Scrub is executed.
 Alternative types include FID-in-dirent and linkEA (namespace) and MDT-OST
 inconsistency (layout).
 .TP
-  -w, --windows
+  -w, --window_size <size>
 The window size for async requests pipeline.
 .TP
-  -o, --orphan
-Handle orphan objects, such as orphan OST-objects for layout LFSCK.
-.TP
-.B lfsck_stop  \fR<-M | --device [MDT,OST]_device>
-     \fR[-A | --all]
-     \fR[-h | --help]
+.B lfsck_stop  \fR<-M | --device [MDT,OST]_device> [-A | --all] [-h | --help]
 Stop LFSCK on the specified MDT or OST device.
 .TP
   -M, --device <[MDT,OST]_device>