Whamcloud - gitweb
LU-4887 lfsck: run all LFSCK scan types by default
[fs/lustre-release.git] / lustre / doc / lctl.8
index 466ad3c..dc71f4a 100644 (file)
@@ -312,49 +312,63 @@ Start LFSCK on the specified MDT or OST device with specified parameters.
 The MDT or OST device to start LFSCK/scrub on.
 .TP
   -A, --all
-Start LFSCK on all MDT devices.
+Start LFSCK on all available MDT devices.
 .TP
   -c, --create_ostobj [on | off]
-Create the lost OST-object for dangling LOV EA: 'off'(default) or 'on'. Under
+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.
+will report the inconsistency but will not repair it.  If 'on' is given, then
+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.
-Otherwise the default behavior is to 'continue' if a repair is impossible.
+With error_handle as 'abort' then if a repair is impossible LFSCK will save
+the current position stop with an error.  Otherwise the default behavior is
+to 'continue' if a repair is impossible.
 .TP
   -h, --help
-Show this help.
+Show the usage message.
 .TP
   -n, --dryrun [on | off]
-Perform a trial run with no changes made. Default is 'off'
+Perform a trial run with no changes made, if 'on' or no argument is given.
+Default is 'off', meaning that any inconsistencies found will be repaired.
 .TP
   -o, --orphan
-Handle orphan objects, such as orphan OST-objects for layout LFSCK.
+Handle orphan objects, such as orphan OST-objects for layout LFSCK by
+linking them under the .../.lustre/lost+found directory.
 .TP
   -r, --reset
 Set the current position of object iteration to the beginning of the specified
-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.
+device. The non-specified parameters will also be reset to the default. By
+default the iterator will resume the scanning from the last saved checkpoint
+position, and other unspecified parameters will be the same as the prior
+incomplete 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.
+Set the upper limit of LFSCK processing in objects per second to reduce load
+on the servers and storage. If no value is specified the saved value is used
+(if resuming from a checkpoint). Otherwise the default value of 0 is used,
+which means check the filesystem as quickly as possible.
 .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)
-corresponding to some known system inconsistency, will be started. Anytime
-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).
+The type of LFSCK checking/repair to execute. If no type is given and the
+previous run was incomplete or internal consistency checks detected an error,
+then the same types are used for the next run.  Otherwise, the default is to
+check all types of consistency.  Any time LFSCK is triggered on an ldiskfs
+MDT or OST then OI Scrub is run.  Valid types are a comma-separated list of one or more of
+.B scrub
+to run only the local OI Scrub on ldiskfs targets,
+.B namespace
+for FID-in-dirent and linkEA checking on the MDT(s),
+.B layout
+for MDT-OST cross-reference consistency, and
+.B all
+to run all of the available check types.
 .TP
   -w, --window_size <size>
-The window size for async requests pipeline.
+Specifies the maximum number of in-flight request being processed at
+one time.  This controls the load placed on remote OSTs when running
+.B layout
+checks.  By default there are at most 1024 outstanding requests.
 .TP
 .B lfsck_stop  \fR<-M | --device [MDT,OST]_device> [-A | --all] [-h | --help]
 Stop LFSCK on the specified MDT or OST device.