From 041e699daec9e22a60ce8daf97a118933df031d4 Mon Sep 17 00:00:00 2001 From: James Nunez Date: Tue, 8 Apr 2014 08:40:26 -0600 Subject: [PATCH 1/1] LU-4862 doc: Update lctl man page for LFSCK phase 2 Update the lctl man page with functionality and options added by LFSCK phase 2. The lfsck_start and lfsck_stop options are updated. Signed-off-by: James Nunez Change-Id: I535faf92feb40cd0a58c6532ef7ad2702213fdfb Reviewed-on: http://review.whamcloud.com/9910 Tested-by: Jenkins Reviewed-by: Fan Yong Tested-by: Maloo Reviewed-by: Andreas Dilger --- lustre/doc/lctl.8 | 52 +++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 37 insertions(+), 15 deletions(-) diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8 index b50a1f6..a9bc9a0 100644 --- a/lustre/doc/lctl.8 +++ b/lustre/doc/lctl.8 @@ -293,53 +293,75 @@ will not be purged beyond any registered users' set point. (See lfs changelog_cl .BI changelog_deregister " " Unregister an existing changelog user. If the user's "clear" record number is the minimum for the device, changelog records will be purged until the -next minimum. +next minimum. .PP .SS LFSCK An on-line Lustre consistency check and repair tool. .TP -.B lfsck_start \fR<-M | --device MDT_device> +.B lfsck_start \fR<-M | --device [MDT,OST]_device> \fR[-e | --error ] \fR[-h | --help] \fR[-n | --dryrun ] \fR[-r | --reset] \fR[-s | --speed ] + \fR[-A | --all] \fR[-t | --type ] + \fR[-w | --windows ] + \fR[-o | --orphan] .br -Start LFSCK on the specified MDT device with specified parameters. +Start LFSCK on the specified MDT or OST device with specified parameters. .TP - -M, --device -The MDT device to check. + -M, --device +The MDT or OST device to start LFSCK/scrub on. .TP -e, --error 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 rapair is impossible. +Otherwise the default behavior is to 'continue' if a repair is impossible. .TP -h, --help Show this help. .TP -n, --dryrun -Perform a trial run with no changes made. +Perform a trial run with no changes made. Default is 'off' .TP -r, --reset -Set the current position of LFSCK progress to the beginning of the specified -MDT. +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. .TP -s, --speed 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 -Specify the type of LFSCK to execute. By default, OI Scrub is executed. -Alternative types include FID-in-dirent and linkEA (namespace). +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). +.TP + -w, --windows +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] +Stop LFSCK on the specified MDT or OST device. .TP -.B lfsck_stop \fR<-M | --device MDT_device> [-h | --help] -Stop LFSCK on the specified MDT device. + -M, --device <[MDT,OST]_device> +The MDT or OST device to stop LFSCK/scrub on. .TP - -M, --device -The MDT device. + -A, --all +Stop LFSCK on all devices. .TP -h, --help Show this help. -- 1.8.3.1