xfsprogs: manpage & usage string fixups
cover xfsprogs: manpage & usage string fixups
The helpful QE elves at Red Hat wrote scripts to check manpages, usage strings, and actual accepted arguments, and found lots of inconsistencies in xfsprogs, as well as spelling errors. Fixups follow.
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
PATCH 1/3 xfsprogs: manpage spelling fixes
Fix several spelling errors in xfsprogs manpages.
---
man/man5/projects.5 +1 -1
@@ -1,6 +1,6 @@ .TH projects 5 .SH NAME -projects \- persistent project root defintion +projects \- persistent project root definition .SH DESCRIPTION The .I /etc/projects
man/man8/mkfs.xfs.8 +2 -2
@@ -279,7 +279,7 @@ with .BR log= , or as the number fitting in a filesystem block with .BR perblock= . -The mininum (and default) +The minimum (and default) .I value is 256 bytes. The maximum
@@ -297,7 +297,7 @@ so if no inode size is given on the command line, .B mkfs.xfs will attempt to choose a size such that inode numbers will be < 32 bits. If an inode size -is specified, or if a filesystem is sufficently large, +is specified, or if a filesystem is sufficiently large, .B mkfs.xfs will warn if this will create inode numbers > 32 significant bits.
man/man8/xfs_db.8 +11 -11
@@ -960,12 +960,12 @@ and (1 if the extent is unwritten). .TP .B keys -[nonleaf blocks only] array of key records. These are the first key +[non-leaf blocks only] array of key records. These are the first key value of each block in the level below this one. Each record contains .BR startoff . .TP .B ptrs -[nonleaf blocks only] array of child block pointers. +[non-leaf blocks only] array of child block pointers. Each pointer is a filesystem block number to the next level in the Btree. .PD .RE
@@ -975,7 +975,7 @@ There is one set of filesystem blocks forming the by-block-number allocation Btree for each allocation group. The root block of this Btree is designated by the .B bnoroot -field in the coresponding AGF block. +field in the corresponding AGF block. The blocks are linked to sibling left and right blocks at each level, as well as by pointers from parent to child blocks. Each block has the following fields:
@@ -1004,14 +1004,14 @@ and .BR blockcount . .TP .B keys -[nonleaf blocks only] array of key records. These are the first value +[non-leaf blocks only] array of key records. These are the first value of each block in the level below this one. Each record contains .B startblock and .BR blockcount . .TP .B ptrs -[nonleaf blocks only] array of child block pointers. Each pointer is a +[non-leaf blocks only] array of child block pointers. Each pointer is a block number within the allocation group to the next level in the Btree. .PD .RE
@@ -1021,7 +1021,7 @@ There is one set of filesystem blocks forming the by-block-count allocation Btree for each allocation group. The root block of this Btree is designated by the .B cntroot -field in the coresponding AGF block. The blocks are linked to sibling +field in the corresponding AGF block. The blocks are linked to sibling left and right blocks at each level, as well as by pointers from parent to child blocks. Each block has the following fields: .RS 1.4i
@@ -1049,14 +1049,14 @@ and .BR blockcount . .TP .B keys -[nonleaf blocks only] array of key records. These are the first value +[non-leaf blocks only] array of key records. These are the first value of each block in the level below this one. Each record contains .B blockcount and .BR startblock . .TP .B ptrs -[nonleaf blocks only] array of child block pointers. Each pointer is a +[non-leaf blocks only] array of child block pointers. Each pointer is a block number within the allocation group to the next level in the Btree. .PD .RE
@@ -1368,7 +1368,7 @@ number of warnings issued about realtime block limit violations. There is one set of filesystem blocks forming the inode allocation Btree for each allocation group. The root block of this Btree is designated by the .B root -field in the coresponding AGI block. +field in the corresponding AGI block. The blocks are linked to sibling left and right blocks at each level, as well as by pointers from parent to child blocks. Each block has the following fields:
@@ -1400,12 +1400,12 @@ count of free inodes in this chunk, and bitmap, LSB corresponds to inode 0. .TP .B keys -[nonleaf blocks only] array of key records. These are the first value of each +[non-leaf blocks only] array of key records. These are the first value of each block in the level below this one. Each record contains .BR startino . .TP .B ptrs -[nonleaf blocks only] array of child block pointers. Each pointer is a +[non-leaf blocks only] array of child block pointers. Each pointer is a block number within the allocation group to the next level in the Btree. .PD .RE
man/man8/xfs_mdrestore.8 +1 -1
@@ -16,7 +16,7 @@ to a filesystem. The .I source argument specifies the location of the metadump image and the .I target -argument specifies the destination for the filsystem image. +argument specifies the destination for the filesystem image. If the .I source is \-, then the metadata image is read from stdin. This allows the output of
man/man8/xfs_quota.8 +1 -1
@@ -623,7 +623,7 @@ can be used to limit recursion level (\-1 is infinite, 0 is top level only, 1 is first level ... ). Option .B \-p -adds posibility to specify project paths in command line without a need +adds possibility to specify project paths in command line without a need for .I /etc/projects to exist. Note that if projects file exists then it is also used.
man/man8/xfs_repair.8 +2 -2
@@ -170,7 +170,7 @@ Verbose output. Repair dangerously. Allow .B xfs_repair to repair an XFS filesystem mounted read only. This is typically done -on a root fileystem from single user mode, immediately followed by a reboot. +on a root filesystem from single user mode, immediately followed by a reboot. .TP .B \-V Prints out the current version number and exits.
@@ -239,7 +239,7 @@ The name assigned is the inode number. aborts on most disk I/O errors. Therefore, if you are trying to repair a filesystem that was damaged due to a disk drive failure, steps should be taken to ensure that all blocks in the filesystem are -readable and writeable before attempting to use +readable and writable before attempting to use .B xfs_repair to repair the filesystem. A possible method is using .BR dd (8)
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
PATCH 2/3 xfsprogs: Fix manpages for missing or incorrect options
In reply to Eric SandeenAdd valid options which aren't in manpages, and
remove invalid options which are in manpages:
* Document -V (show version and exit) for many manpages.
* Remove -? option from xfs_estimate.8
* Document -p passes, -d (debug) and -g (syslog) in xfs_fsr.8
* Document -n (O_NONBLOCK) in xfs_io.8
* Document -v (print overwrite) in xfs_logprint.8
* Document -m max_extents in xfs_metadump.8
* Document -p (preallocate) in xfs_mkfile.8
---
man/man8/mkfs.xfs.8 +5 -0
@@ -38,6 +38,8 @@ mkfs.xfs \- construct an XFS filesystem .B \-N ] [ .B \-K +] [ +.B \-V ] .I device .SH DESCRIPTION
@@ -728,6 +730,9 @@ creating the file system. .TP .B \-K Do not attempt to discard blocks at mkfs time. +.TP +.B \-V +Prints the version number and exits. .SH SEE ALSO .BR xfs (5), .BR mkfs (8),
man/man8/xfs_admin.8 +4 -1
@@ -4,7 +4,7 @@ xfs_admin \- change parameters of an XFS filesystem .SH SYNOPSIS .B xfs_admin [ -.B \-eflpu +.B \-eflpuV ] [ .BR "\-c 0" | 1 ] [
@@ -97,6 +97,9 @@ The may also be .BR generate , which will generate a new UUID for the filesystem. +.TP +.B \-V +Prints the version number and exits. .PP The .BR mount (8)
man/man8/xfs_bmap.8 +4 -1
@@ -4,7 +4,7 @@ xfs_bmap \- print block mapping for an XFS file .SH SYNOPSIS .B xfs_bmap [ -.B \-adlpv +.B \-adlpvV ] [ .B \-n .I num_extents
@@ -91,6 +91,9 @@ A second option will print out the .I flags legend. +.TP +.B \-V +Prints the version number and exits. .SH SEE ALSO .BR xfs_fsr (8), .BR xfs (5).
man/man8/xfs_check.8 +5 -0
@@ -16,6 +16,8 @@ xfs_check \- check XFS filesystem consistency ] [ .B \-v ] [ +.B \-V +] [ .B \-l .I logdev ]
@@ -73,6 +75,9 @@ Specifies verbose output; it is impossibly long for a reasonably-sized filesystem. This option is intended for internal use only. .TP +.B \-V +Prints the version number and exits. +.TP .BI \-i " ino" Specifies verbose behavior for the specified inode .IR ino .
man/man8/xfs_copy.8 +4 -1
@@ -4,7 +4,7 @@ xfs_copy \- copy the contents of an XFS filesystem .SH SYNOPSIS .B xfs_copy [ -.B \-bd +.B \-bdV ] [ .B \-L .I log
@@ -81,6 +81,9 @@ The buffered option can be used to ensure direct IO is not attempted to any of the target files. This is useful when the filesystem holding the target file does not support direct IO. .TP +.B \-V +Prints the version number and exits. +.TP .BI \-L " log" Specifies the location of the .I log
man/man8/xfs_estimate.8 +1 -4
@@ -3,7 +3,7 @@ xfs_estimate \- estimate the space that an XFS filesystem will take .SH SYNOPSIS .nf -\f3xfs_estimate\f1 [ \f3\-h?\f1 ] [ \f3\-b\f1 blocksize ] [ \f3\-i\f1 logsize ] +\f3xfs_estimate\f1 [ \f3\-h\f1 ] [ \f3\-b\f1 blocksize ] [ \f3\-i\f1 logsize ] [ \f3\-e\f1 logsize ] [ \f3\-v\f1 ] directory ... .fi .SH DESCRIPTION
@@ -51,9 +51,6 @@ Display more information, formatted. .B \-h Display usage message. .TP -.B \-? -Display usage message. -.TP \f3\-i, \-e\f1 \f2logsize\f1 Use .I logsize
man/man8/xfs_freeze.8 +13 -2
@@ -2,9 +2,14 @@ .SH NAME xfs_freeze \- suspend access to an XFS filesystem .SH SYNOPSIS -.B xfs_freeze \-f +.B xfs_freeze +[ +.B \-V +] [ +.B \-f | .B \-u +] .I mount-point .fi .SH DESCRIPTION
@@ -26,6 +31,10 @@ The filesystem must be mounted to be frozen (see .BR mount (8)). .PP The +.B \-V +flag prints the version number and exits. +.PP +The .B \-f flag requests the specified XFS filesystem to be frozen from new modifications.
@@ -48,7 +57,9 @@ operations to continue. Any filesystem modifications that were blocked by the freeze are unblocked and allowed to complete. .PP -One of +Unless +.B \-V +is specified, one of .B \-f or .B \-u
man/man8/xfs_fsr.8 +14 -4
@@ -3,9 +3,9 @@ xfs_fsr \- filesystem reorganizer for XFS .SH SYNOPSIS .nf -\f3xfs_fsr\f1 [\f3\-v\f1] \c -[\f3\-t\f1 seconds] [\f3\-f\f1 leftoff] [\f3\-m\f1 mtab] -\f3xfs_fsr\f1 [\f3\-v\f1] \c +\f3xfs_fsr\f1 [\f3\-vdg\f1] \c +[\f3\-t\f1 seconds] [\f3\-p\f1 passes] [\f3\-f\f1 leftoff] [\f3\-m\f1 mtab] +\f3xfs_fsr\f1 [\f3\-vdg\f1] \c [xfsdev | file] ... .fi .SH DESCRIPTION
@@ -35,7 +35,11 @@ The default is to use .TP .BI \-t " seconds" How long to reorganize. -The default is 7200 (2 hours). +The default is 7200 seconds (2 hours). +.TP +.BI \-p " passes" +Number of passes before terminating global re-org. +The default is 10 passes. .TP .BI \-f " leftoff" Use this file instead of
@@ -47,6 +51,12 @@ to store the state of where reorganization left off. Verbose. Print cryptic information about each file being reorganized. +.TP +.B \-d +Debug. Print even more cryptic information. +.TP +.B \-g +Print to syslog (default if stdout not a tty). .PP When invoked with no arguments .I xfs_fsr
man/man8/xfs_growfs.8 +2 -0
@@ -39,6 +39,8 @@ xfs_growfs, xfs_info \- expand an XFS filesystem .br .B xfs_info [ +.B \-V +] [ .B \-t .I mtab ]
man/man8/xfs_io.8 +7 -1
@@ -4,7 +4,7 @@ xfs_io \- debug the I/O path of an XFS filesystem .SH SYNOPSIS .B xfs_io [ -.B \-adfmrRstx +.B \-adfmrRstxV ] [ .B \-c .I cmd
@@ -52,6 +52,9 @@ is immutable or append-only. .B \-x Expert mode. Dangerous commands are only available in this mode. These commands also tend to require additional privileges. +.TP +.B \-V +Prints the version number and exits. .PP The other .BR open (2)
@@ -111,6 +114,9 @@ opens for synchronous I/O (O_SYNC). .B \-t truncates on open (O_TRUNC). .TP +.B \-n +opens in non-blocking mode if possible (O_NONBLOCK). +.TP .B \-R marks the file as a realtime XFS file after opening it, if it is not already marked as such.
man/man8/xfs_logprint.8 +6 -0
@@ -97,6 +97,12 @@ Override any notion of where to start printing. .TP .B \-t Print out the transactional view. +.TP +.B \-v +Print "overwrite" data. +.TP +.B \-V +Prints the version number and exits. .SH SEE ALSO .BR mkfs.xfs (8), .BR mount (8).
man/man8/xfs_metadump.8 +9 -0
@@ -6,6 +6,10 @@ xfs_metadump \- copy XFS filesystem metadata to a file [ .B \-efgow ] [ +.B \-m +.I max_extents +] +] [ .B \-l .I logdev ]
@@ -94,6 +98,11 @@ For filesystems which use an external log, this specifies the device where the external log resides. The external log is not copied, only internal logs are copied. .TP +.B \-m +Set the maximum size of an allowed metadata extent. Extremely large metadata +extents are likely to be corrupt, and will be skipped if they exceed +this value. The default size is 1000 blocks. +.TP .B \-o Disables obfuscation of file names and extended attributes. .TP
man/man8/xfs_mkfile.8 +11 -0
@@ -7,6 +7,10 @@ xfs_mkfile \- create an XFS file .B \-v ] [ .B \-n +] [ +.B \-p +] [ +.B \-V ] .I size\c .RB [ k | b | m | g ]
@@ -30,3 +34,10 @@ Verbose. Report the names and sizes of created files. .B \-n No bytes. Create a holey file - that is, do not write out any data, just seek to end of file and write a block. +.TP +.B \-p +Preallocate. The file is preallocated, then overwritten with zeroes, +then truncated to the desired size. +.TP +.B \-V +Prints the version number and exits.
man/man8/xfs_ncheck.8 +5 -0
@@ -11,6 +11,8 @@ xfs_ncheck \- generate pathnames from i-numbers for XFS ] [ .B \-s ] [ +.B \-V +] [ .B \-l .I logdev ]
@@ -53,6 +55,9 @@ for a detailed description of the XFS log. Limits the report to special files and files with setuserid mode. This option may be used to detect violations of security policy. .TP +.B \-V +Prints the version number and exits. +.TP .BI \-i " ino" Limits the report to only those files whose inode numbers follow. May be given multiple times to select multiple inode numbers.
man/man8/xfs_rtcp.8 +5 -0
@@ -8,6 +8,8 @@ xfs_rtcp \- XFS realtime copy command .I extsize ] [ .B -p +] [ +.B -V ] .IR source " ... " target .SH DESCRIPTION
@@ -35,6 +37,9 @@ will pad the destination file to a size which is an even multiple of the filesystem block size. This is necessary since the realtime file is created using direct I/O and the minimum I/O is the filesystem block size. +.TP +.B \-V +Prints the version number and exits. .SH SEE ALSO .BR xfs (5), .BR mkfs.xfs (8),
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
PATCH 3/3 xfsprogs: Fix up usage() errors and omissions
In reply to Eric SandeenAdd missing options and remove invalid options in usage() output strings.
* Add -V to several usage() strings
* Remove deprecated/invalid -n and -s otions from xfs_fsr's usage
* Remove invalid -I option from xfs_growfs's usage
* Add -n (O_NONBLOCK) option to xfs_io's usage
* Add -e (exit on error) option to xfs_logprint's usage
* Remove invalid -b option from xfs_mdrestore's usage
* Add -N (no-op), -K (no discard), and -f (force) to mkfs.xfs's usage
* Add -x (expert) option to xfs_quota's usage
---
copy/xfs_copy.c +1 -1
@@ -301,7 +301,7 @@ voidusage (void) {fprintf (stderr, -_ ("Usage: %s [-bd] [-L logfile] source target [target ...]\n" ), +_ ("Usage: %s [-bdV] [-L logfile] source target [target ...]\n" ), progname);exit (1 ); }
db/init.c +1 -1
@@ -43,7 +43,7 @@ static voidusage (void) {fprintf (stderr,_ ( -"Usage: %s [-fFrxV] [-p prog] [-l logdev] [-c cmd]... device\n" +"Usage: %s [-ifFrxV] [-p prog] [-l logdev] [-c cmd]... device\n" ), progname);exit (1 ); }
fsr/xfs_fsr.c +2 -5
@@ -386,12 +386,9 @@ void usage(int ret) { fprintf(stderr, _( -"Usage: %s [-d] [-v] [-n] [-s] [-g] [-t time] [-p passes] [-f leftf] [-m mtab]\n" -" %s [-d] [-v] [-n] [-s] [-g] xfsdev | dir | file ...\n\n" +"Usage: %s [-d] [-v] [-g] [-t time] [-p passes] [-f leftf] [-m mtab]\n" +" %s [-d] [-v] [-g] xfsdev | dir | file ...\n\n" "Options:\n" -" -n Do nothing, only interesting with -v. Not\n" -" effective with in mtab mode.\n" -" -s Print statistics only.\n" " -g Print to syslog (default if stdout not a tty).\n" " -t time How long to run in seconds.\n" " -p passes Number of passes before terminating global re-org.\n"
growfs/xfs_growfs.c +1 -10
@@ -19,14 +19,6 @@#include <xfs/libxfs.h> #include <xfs/path.h> -/* -* When growing a filesystem, this is the most significant -* bits we'll accept in the resulting inode numbers -* without warning the user. -*/ - -#define XFS_MAX_INODE_SIG_BITS 32 -static void usage (void ) {
@@ -37,7 +29,6 @@ Options:\n\ -l grow log section\n\ -r grow realtime section\n\ -n don't change anything, just show geometry\n\ --I allow inode numbers to exceed %d significant bits\n\ -i convert log from external to internal format\n\ -t alternate location for mount table (/etc/mtab)\n\ -x convert log from internal to external format\n\
@@ -47,7 +38,7 @@ Options:\n\ -e size set realtime extent size to size blks\n\ -m imaxpct set inode max percent to imaxpct\n\ -V print version information\n"), - progname, XFS_MAX_INODE_SIG_BITS); + progname);exit (2 ); }
io/init.c +1 -1
@@ -32,7 +32,7 @@ voidusage (void) {fprintf (stderr, -_ ("Usage: %s [-adfmrRstx] [-p prog] [-c cmd]... file\n" ), +_ ("Usage: %s [-adfmnrRstVx] [-p prog] [-c cmd]... file\n" ), progname);exit (1 ); }
io/xfs_freeze.sh +1 -1
@@ -4,7 +4,7 @@ # OPTS="" -USAGE="Usage: xfs_freeze -f | -u <mountpoint>" +USAGE="Usage: xfs_freeze [-V] [-f | -u] <mountpoint>" DIRNAME=`dirname $0` VERSION=false FREEZE=false
logprint/logprint.c +1 -0
@@ -44,6 +44,7 @@ Options:\n\ -c try to continue if error found in log\n\ -C <filename> copy the log from the filesystem to filename\n\ -d dump the log in log-record format\n\ + -e exit when an error is found in the log\n\ -f specified device is actually a file\n\ -l <device> filename of external log\n\ -n don't try and interpret log data\n\
mdrestore/xfs_mdrestore.c +1 -1
@@ -178,7 +178,7 @@ perform_restore(static void usage (void ) { -fprintf (stderr,"Usage: %s [-bg] source target\n" , progname); +fprintf (stderr,"Usage: %s [-V] [-g] source target\n" , progname);exit (1 ); }
mkfs/xfs_mkfs.c +3 -0
@@ -2911,6 +2911,9 @@ usage( void ) /* realtime subvol */ [-r extsize=num,size=num,rtdev=xxx]\n\ /* sectorsize */ [-s log=n|size=num]\n\ /* version */ [-V]\n\ +/* no-op info only */ [-N]\n\ +/* no discard */ [-K]\n\ +/* force overwrite */ [-f]\n\ devicename\n\ <devicename> is required unless -d name=xxx is given.\n\ <num> is xxx (bytes), xxxs (sectors), xxxb (fs blocks), xxxk (xxx KiB),\n\
quota/init.c +1 -1
@@ -45,7 +45,7 @@ static voidusage (void) {fprintf (stderr, -_ ("Usage: %s [-p prog] [-c cmd]... [-d project]... [path]\n" ), +_ ("Usage: %s [-x] [-p prog] [-c cmd]... [-d project]... [path]\n" ), progname);exit (1 ); }
rtcp/xfs_rtcp.c +1 -1
@@ -27,7 +27,7 @@ char *progname;void usage () { -fprintf (stderr,_ ("%s [-e extsize] [-p] source target\n" ), progname); +fprintf (stderr,_ ("%s [-e extsize] [-p] [-V] source target\n" ), progname);exit (2 ); }
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 1/3] xfsprogs: manpage spelling fixes
In reply to Eric Sandeenman/man5/projects.5
Quoted 6 lines · Eric Sandeen
Fix several spelling errors in xfsprogs manpages.
Signed-off-by Eric Sandeen <[email protected]>---
man/man5/projects.5 +0
-0
#rcj OK
man/man8/mkfs.xfs.8
Quoted 1 line
man/man8/mkfs.xfs.8 +0
-0
#rcj serialisation is misspelled, should be serialization.
man/man8/xfs_db.8
Quoted 1 line
man/man8/xfs_db.8 +0
-0
#rcj guarenteed should be guaranteed
#rcj Nonleaf to Non-leaf ???? not sure about that one :)
man/man8/xfs_mdrestore.8
Quoted 1 line
man/man8/xfs_mdrestore.8 +0
-0
#rcj OK
man/man8/xfs_quota.8
Quoted 1 line
man/man8/xfs_quota.8 +0
-0
#rcj OK
man/man8/xfs_repair.8
Quoted 1 line
man/man8/xfs_repair.8 +0
-0
#rcj OK
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 1/3] xfsprogs: manpage spelling fixes
Quoted 2 lines · Rich Johnston
man/man8/mkfs.xfs.8
Quoted 1 line
man/man8/mkfs.xfs.8 +0
-0#rcj serialisation is misspelled, should be serialization.
That depends on where you live, of course. It is derived from a Latin root, I think, so should have an 's'. At least, where I live.
Do manpages have a policy as regards spelling?
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 1/3] xfsprogs: manpage spelling fixes
Quoted 6 lines · Dave Howorth
Quoted 2 lines · Rich Johnston
man/man8/mkfs.xfs.8
Quoted 1 line
man/man8/mkfs.xfs.8 +0
-0#rcj serialisation is misspelled, should be serialization.
That depends on where you live, of course. It is derived from a Latin root, I think, so should have an 's'. At least, where I live.
Good point Dave, I did not think to look that one up online, my bad for trusting my spell checker and my locale. ;)
Was unaware that that one is spelled two ways (darn British have to spell it differently, or is it those darn colonists don't know how to spell i.e. color colour)
Quoted 2 lines
Do manpages have a policy as regards spelling?
Not to my knowledge.
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 1/3] xfsprogs: manpage spelling fixes
Quoted 3 lines
Quoted 1 line
Do manpages have a policy as regards spelling?
Not to my knowledge.
But if the rest of the man page / package is en_US, as is likely the case, it would make sense to stick to this locale.
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 2/3] xfsprogs: Fix manpages for missing or incorrect options
In reply to Eric SandeenHey Eric,
Couple of comments.
1. The OPTIONS are listed in several ways, (alphabetical order, same order as they appear in the SYNOPSIS, ...). I don't really have a preference, but as long as we are cleaning up the manpages, I suggest we be consistent. (case insensitive alpha order maybe???)
2. How about making the -V option wording the same also? xfs_db and xfs_repair are:
Prints out the current version number and exits.
^^^^^^^^
The others:
man/man8/mkfs.xfs.8:Prints the version number and exits. man/man8/xfs_admin.8:Prints the version number and exits. man/man8/xfs_bmap.8:Prints the version number and exits. man/man8/xfs_check.8:Prints the version number and exits. man/man8/xfs_copy.8:Prints the version number and exits. man/man8/xfs_growfs.8:Prints the version number and exits. The man/man8/xfs_io.8:Prints the version number and exits. man/man8/xfs_logprint.8:Prints the version number and exits. man/man8/xfs_mkfile.8:Prints the version number and exits. man/man8/xfs_ncheck.8:Prints the version number and exits. man/man8/xfs_rtcp.8:Prints the version number and exits.
3. The following are missing the -V option in both the SYNOPSIS and OPTIONS sections. (I did verify the -V option works for all commands) man/man8/xfs_estimate.8
man/man8/xfs_freeze.8
man/man8/xfs_fsr.8
man/man8/xfs_mdrestore.8
man/man8/xfs_metadump.8
man/man8/xfs_quota.8
man/man8/xfs_repair.8
4. The -V prints the version and exits, shouldn't all the SYNOPSIS look like this for the -V option?
SYNOPSIS
xfs_db [ -c cmd ] ... [ -i|r|x|F ] [ -f ] [ -l logdev ] ...
xfs_db -VRegards
--Rich
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 2/3] xfsprogs: Fix manpages for missing or incorrect options
Quoted 8 lines · Rich Johnston
Hey Eric,
Couple of comments.
1. The OPTIONS are listed in several ways, (alphabetical order, same order as they appear in the SYNOPSIS, ...). I don't really have a preference, but as long as we are cleaning up the manpages, I suggest we be consistent. (case insensitive alpha order maybe???)
That'd make a fine followup patch, I agree! ;) Re-ordering every manpage won't really be on my todo list soon, though.
Quoted 4 lines
2. How about making the -V option wording the same also?
xfs_dbandxfs_repairare:
Prints out the current version number and exits.
^^^^^^^^
I suppose. I'm not really sure anyone would care?
Quoted 13 lines
The others:
man/man8/mkfs.xfs.8:Prints the version number and exits. man/man8/xfs_admin.8:Prints the version number and exits. man/man8/xfs_bmap.8:Prints the version number and exits. man/man8/xfs_check.8:Prints the version number and exits. man/man8/xfs_copy.8:Prints the version number and exits. man/man8/xfs_growfs.8:Prints the version number and exits. The man/man8/xfs_io.8:Prints the version number and exits. man/man8/xfs_logprint.8:Prints the version number and exits. man/man8/xfs_mkfile.8:Prints the version number and exits. man/man8/xfs_ncheck.8:Prints the version number and exits. man/man8/xfs_rtcp.8:Prints the version number and exits.
Quoted 9 lines
3. The following are missing the -V option in both the SYNOPSIS and OPTIONS sections. (I did verify the -V option works for all commands) man/man8/xfs_estimate.8
man/man8/xfs_freeze.8
man/man8/xfs_fsr.8
man/man8/xfs_mdrestore.8
man/man8/xfs_metadump.8
man/man8/xfs_quota.8
man/man8/xfs_repair.8
not sure how I missed those, sorry.
Quoted 6 lines
4. The -V prints the version and exits, shouldn't all the SYNOPSIS look like this for the -V option?
SYNOPSIS
xfs_db [ -c cmd ] ... [ -i|r|x|F ] [ -f ] [ -l logdev ] ... xfs_db -V
Probably. -V is least important of the fixes; I'd be more inclined to just drop the -V changes and not spend a couple more hours rearranging manpages.
This was fine work on a plane, but there are more pressing things to do now :(
Maybe some list-reader who wants some changelog glory could take this further? :)
-Eric
Quoted 8 lines
Regards
--Rich_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 1/3] xfsprogs: manpage spelling fixes
In reply to Rich JohnstonQuoted 6 lines · Rich Johnston
Quoted 5 lines · Eric Sandeen
Fix several spelling errors in xfsprogs manpages.
Signed-off-by Eric Sandeen <[email protected]>---
Quoted 8 lines
man/man5/projects.5
Quoted 1 line
man/man5/projects.5 +0
-0#rcj OK
man/man8/mkfs.xfs.8
Quoted 1 line
man/man8/mkfs.xfs.8 +0
-0#rcj serialisation is misspelled, should be serialization.
man/man8/xfs_db.8
Quoted 1 line
man/man8/xfs_db.8 +0
-0#rcj guarenteed should be guaranteed
whoops I missed that, didn't introduce it, did I?
Quoted 1 line
#rcj Nonleaf to Non-leaf ???? not sure about that one :)
$ aspell -a @(#) International Ispell Version 3.1.20 (but really Aspell 0.60.6) nonleaf & nonleaf 11 0: non leaf, non-leaf, ...
*shrug*
-Eric
Quoted 6 lines
man/man8/xfs_mdrestore.8
Quoted 1 line
man/man8/xfs_mdrestore.8 +0
-0#rcj OK
man/man8/xfs_quota.8
Quoted 1 line
man/man8/xfs_quota.8 +0
-0#rcj OK
Quoted 8 lines
man/man8/xfs_repair.8
Quoted 1 line
man/man8/xfs_repair.8 +0
-0#rcj OK
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 3/3] xfsprogs: Fix up usage() errors and omissions
In reply to Eric SandeenQuoted 4 lines · Eric Sandeen
Add missing options and remove invalid options in
usage()output strings.* Add -V to several
usage()strings
Need to add it forxfs_estimatexfs_fsrxfs_quota
I ran this.
MYCMDS="mkfs.xfs xfs_admin xfs_bmap xfs_check xfs_copy xfs_db xfs_estimate xfs_freeze xfs_fsr xfs_growfs xfs_info xfs_io xfs_logprint xfs_mdrestore xfs_metadump xfs_mkfile xfs_ncheck xfs_quota xfs_rtcp"
for i in $MYCMDS; do
$i -h echo
done
Here are the cmds that are missing -V:
Quoted 12 lines
mkfs.xfs: invalid option -- 'h'
unknown option -h
Usage: mkfs.xfs
/* blocksize */ [-b log=n|size=num]
/* data subvol */ [-d agcount=n,agsize=n,file,name=xxx,size=num,
(sunit=value,swidth=value|su=num,sw=num), sectlog=n|sectsize=num
/* inode size */ [-i log=n|perblock=n|size=num,maxpct=n,attr=0|1|2,projid32bit=0|1] /* log subvol */ [-l agnum=n,internal,size=num,logdev=xxx,version=n sunit=value|su=num,sectlog=n|sectsize=num, lazy-count=0|1]
Quoted 16 lines
/* label */ [-L label (maximum 12 characters)]
/* naming */ [-n log=n|size=num,version=2|ci]
/* prototype file */ [-p fname]
/* quiet */ [-q]
/* realtime subvol */ [-r extsize=num,size=num,rtdev=xxx]
/* sectorsize */ [-s log=n|size=num]
/* version */ [-V]
/* no-op info only */ [-N]
/* no discard */ [-K]
/* force overwrite */ [-f]
devicename
<devicename> is required unless -d name=xxx is given.
<num> is xxx (bytes), xxxs (sectors), xxxb (fs blocks), xxxk (xxx KiB),
xxxm (xxx MiB), xxxg (xxx GiB), xxxt (xxx TiB) or xxxp (xxx PiB).
<value> is xxx (512 byte blocks).
#rcj mkfs.xfs missing -V
Quoted 9 lines
Usage:
xfs_estimate[opts] directory [directory ...]
-b blocksize (fundamental filesystem blocksize) -i logsize (internal log size)
-e logsize (external log size)
-v prints more verbose messages
-h prints this usage messageNote: blocksize may have 'k' appended to indicate x1024
logsize may also have 'm' appended to indicate (1024 x 1024)
#rcj xfs_estimate missing -V
Quoted 4 lines
xfs_fsr: invalid option -- 'h'
Usage:xfs_fsr[-d] [-v] [-g] [-t time] [-p passes] [-f leftf] [-m mtab]xfs_fsr [-d] [-v] [-g] xfsdev | dir | file ...
Quoted 9 lines
Options:
-g Print to syslog (default if stdout not a tty).
-t time How long to run in seconds.
-p passes Number of passes before terminating global re-org.
-f leftoff Use this instead of/var/tmp/.fsrlast_xfs.
-m mtab Use something other than/etc/mtab.
-d Debug, print even more.
-v Verbose, more -v's more verbose.
#rcj xfs_fsr missing -V
Quoted 2 lines
xfs_quota: invalid option -- 'h'
Usage:xfs_quota[-x] [-p prog] [-c cmd]... [-d project]... [path]
#rcj missing -V
_______________________________________________________________________
All commands report the version.
MYCMDS="mkfs.xfs xfs_admin xfs_bmap xfs_check xfs_copy xfs_db xfs_estimate xfs_freeze xfs_fsr xfs_growfs xfs_info xfs_io xfs_logprint xfs_mdrestore xfs_metadump xfs_mkfile xfs_ncheck xfs_quota xfs_rtcp"
for i in $MYCMDS; do
$i -V
done
mkfs.xfs version 3.1.10xfs_admin version 3.1.10xfs_bmap version 3.1.10xfs_check is deprecated and scheduled for removal in June 2014. Please use xfs_repair -n <dev> instead.xfs_check version 3.1.10xfs_copy version 3.1.10xfs_db version 3.1.10xfs_estimate version 3.1.10xfs_freeze version 3.1.10xfs_fsr version 3.1.10xfs_growfs version 3.1.10xfs_info version 3.1.10xfs_io version 3.1.10xfs_logprint version 3.1.10xfs_mdrestore version 3.1.10xfs_metadump version 3.1.10xfs_mkfile version 3.1.10xfs_ncheck version 3.1.10xfs_quota version 3.1.10xfs_rtcp version 3.1.10
Quoted 1 line
* Remove deprecated/invalid -n and -s otions from xfs_fsr's usage
#rcj OK
Quoted 1 line
* Remove invalid -I option from xfs_growfs's usage
#rcj OK
Quoted 1 line
* Add -n (
O_NONBLOCK) option to xfs_io's usage
#rcj OK
Quoted 1 line
* Add -e (exit on error) option to xfs_logprint's usage
#rcj OK
Quoted 1 line
* Remove invalid -b option from xfs_mdrestore's usage
#rcj OK
Quoted 1 line
* Add -N (no-op), -K (no discard), and -f (force) to mkfs.xfs's usage
Usage: mkfs.xfs
/* blocksize */ [-b log=n|size=num]
/* data subvol */ [-d agcount=n,agsize=n,file,name=xxx,size=num,
(sunit=value,swidth=value|su=num,sw=num), sectlog=n|sectsize=num
/* force overwrite */ [-f]
devicename
#rcj move to here ?????
/* inode size */ [-i log=n|perblock=n|size=num,maxpct=n,attr=0|1|2,
projid32bit=0|1]
/* no discard */ [-K]
#rcj move to here ????
/* log subvol */ [-l agnum=n,internal,size=num,logdev=xxx,version=n
sunit=value|su=num,sectlog=n|sectsize=num, lazy-count=0|1]
/* label */ [-L label (maximum 12 characters)]
/* naming */ [-n log=n|size=num,version=2|ci]
/* no-op info only */ [-N]
#rcj move to here ????
/* prototype file */ [-p fname]
/* quiet */ [-q]
/* realtime subvol */ [-r extsize=num,size=num,rtdev=xxx]
/* sectorsize */ [-s log=n|size=num]
/* version */ [-V]
Quoted 1 line
* Add -x (expert) option to xfs_quota's usage
#rcj OK
Regards
--Rich
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 2/3] xfsprogs: Fix manpages for missing or incorrect options
In reply to Eric SandeenQuoted 5 lines · Eric Sandeen
Quoted 4 lines · Rich Johnston
Hey Eric,
Couple of comments.
Quoted 8 lines
Quoted 4 lines
1. The OPTIONS are listed in several ways, (alphabetical order, same order as they appear in the SYNOPSIS, ...). I don't really have a preference, but as long as we are cleaning up the manpages, I suggest we be consistent. (case insensitive alpha order maybe???)
That'd make a fine followup patch, I agree! ;) Re-ordering every manpage won't really be on my todo list soon, though.
Sounds good.
Quoted 7 lines
Quoted 4 lines
2. How about making the -V option wording the same also?
xfs_dbandxfs_repairare:
Prints out the current version number and exits.
^^^^^^^^I suppose. I'm not really sure anyone would care?
Not important just noting it ;)
Quoted 23 lines
Quoted 13 lines
The others:
man/man8/mkfs.xfs.8:Prints the version number and exits. man/man8/xfs_admin.8:Prints the version number and exits. man/man8/xfs_bmap.8:Prints the version number and exits. man/man8/xfs_check.8:Prints the version number and exits. man/man8/xfs_copy.8:Prints the version number and exits. man/man8/xfs_growfs.8:Prints the version number and exits. The man/man8/xfs_io.8:Prints the version number and exits. man/man8/xfs_logprint.8:Prints the version number and exits. man/man8/xfs_mkfile.8:Prints the version number and exits. man/man8/xfs_ncheck.8:Prints the version number and exits. man/man8/xfs_rtcp.8:Prints the version number and exits.Quoted 9 lines
3. The following are missing the -V option in both the SYNOPSIS and OPTIONS sections. (I did verify the -V option works for all commands) man/man8/xfs_estimate.8
man/man8/xfs_freeze.8
man/man8/xfs_fsr.8
man/man8/xfs_mdrestore.8
man/man8/xfs_metadump.8
man/man8/xfs_quota.8
man/man8/xfs_repair.8
Quoted 1 line
not sure how I missed those, sorry.
Do you have time to add these? This really the only todo for now I think.
Quoted 4 lines
Quoted 4 lines
4. The -V prints the version and exits, shouldn't all the SYNOPSIS look like this for the -V option?
Quoted 8 lines
Quoted 3 lines
SYNOPSIS
xfs_db [ -c cmd ] ... [ -i|r|x|F ] [ -f ] [ -l logdev ] ... xfs_db -VProbably. -V is least important of the fixes; I'd be more inclined to just drop the -V changes and not spend a couple more hours rearranging manpages.
This was fine work on a plane, but there are more pressing things to do now :(
Agreed
Quoted 3 lines
Maybe some list-reader who wants some changelog glory could take this further? :)
Yes a follow up patch works for me, any volunteers?
Quoted 11 lines
-Eric
Quoted 8 lines
Regards
--Rich_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
PATCH v2 1/3 xfsprogs: manpage spelling fixes
In reply to Eric SandeenFix several spelling errors in xfsprogs manpages.
---
V2: fix serialization, guaranteed
man/man5/projects.5 +1 -1
@@ -1,6 +1,6 @@ .TH projects 5 .SH NAME -projects \- persistent project root defintion +projects \- persistent project root definition .SH DESCRIPTION The .I /etc/projects
man/man8/mkfs.xfs.8 +3 -3
@@ -279,7 +279,7 @@ with .BR log= , or as the number fitting in a filesystem block with .BR perblock= . -The mininum (and default) +The minimum (and default) .I value is 256 bytes. The maximum
@@ -297,7 +297,7 @@ so if no inode size is given on the command line, .B mkfs.xfs will attempt to choose a size such that inode numbers will be < 32 bits. If an inode size -is specified, or if a filesystem is sufficently large, +is specified, or if a filesystem is sufficiently large, .B mkfs.xfs will warn if this will create inode numbers > 32 significant bits.
@@ -450,7 +450,7 @@ suboption is specified. This changes the method of logging various persistent counters in the superblock. Under metadata intensive workloads, these counters are updated and logged frequently enough that the superblock -updates become a serialisation point in the filesystem. The +updates become a serialization point in the filesystem. The .I value can be either 0 or 1. .IP
man/man8/xfs_db.8 +12 -12
@@ -64,7 +64,7 @@ and Allows execution on a mounted filesystem, provided it is mounted read-only. Useful for shell scripts such as .BR xfs_check (8), -which must only operate on filesystems in a guarenteed consistent state +which must only operate on filesystems in a guaranteed consistent state (either unmounted or mounted read-only). These semantics are slightly different to that of the .B -r
@@ -960,12 +960,12 @@ and (1 if the extent is unwritten). .TP .B keys -[nonleaf blocks only] array of key records. These are the first key +[non-leaf blocks only] array of key records. These are the first key value of each block in the level below this one. Each record contains .BR startoff . .TP .B ptrs -[nonleaf blocks only] array of child block pointers. +[non-leaf blocks only] array of child block pointers. Each pointer is a filesystem block number to the next level in the Btree. .PD .RE
@@ -975,7 +975,7 @@ There is one set of filesystem blocks forming the by-block-number allocation Btree for each allocation group. The root block of this Btree is designated by the .B bnoroot -field in the coresponding AGF block. +field in the corresponding AGF block. The blocks are linked to sibling left and right blocks at each level, as well as by pointers from parent to child blocks. Each block has the following fields:
@@ -1004,14 +1004,14 @@ and .BR blockcount . .TP .B keys -[nonleaf blocks only] array of key records. These are the first value +[non-leaf blocks only] array of key records. These are the first value of each block in the level below this one. Each record contains .B startblock and .BR blockcount . .TP .B ptrs -[nonleaf blocks only] array of child block pointers. Each pointer is a +[non-leaf blocks only] array of child block pointers. Each pointer is a block number within the allocation group to the next level in the Btree. .PD .RE
@@ -1021,7 +1021,7 @@ There is one set of filesystem blocks forming the by-block-count allocation Btree for each allocation group. The root block of this Btree is designated by the .B cntroot -field in the coresponding AGF block. The blocks are linked to sibling +field in the corresponding AGF block. The blocks are linked to sibling left and right blocks at each level, as well as by pointers from parent to child blocks. Each block has the following fields: .RS 1.4i
@@ -1049,14 +1049,14 @@ and .BR blockcount . .TP .B keys -[nonleaf blocks only] array of key records. These are the first value +[non-leaf blocks only] array of key records. These are the first value of each block in the level below this one. Each record contains .B blockcount and .BR startblock . .TP .B ptrs -[nonleaf blocks only] array of child block pointers. Each pointer is a +[non-leaf blocks only] array of child block pointers. Each pointer is a block number within the allocation group to the next level in the Btree. .PD .RE
@@ -1368,7 +1368,7 @@ number of warnings issued about realtime block limit violations. There is one set of filesystem blocks forming the inode allocation Btree for each allocation group. The root block of this Btree is designated by the .B root -field in the coresponding AGI block. +field in the corresponding AGI block. The blocks are linked to sibling left and right blocks at each level, as well as by pointers from parent to child blocks. Each block has the following fields:
@@ -1400,12 +1400,12 @@ count of free inodes in this chunk, and bitmap, LSB corresponds to inode 0. .TP .B keys -[nonleaf blocks only] array of key records. These are the first value of each +[non-leaf blocks only] array of key records. These are the first value of each block in the level below this one. Each record contains .BR startino . .TP .B ptrs -[nonleaf blocks only] array of child block pointers. Each pointer is a +[non-leaf blocks only] array of child block pointers. Each pointer is a block number within the allocation group to the next level in the Btree. .PD .RE
man/man8/xfs_mdrestore.8 +1 -1
@@ -16,7 +16,7 @@ to a filesystem. The .I source argument specifies the location of the metadump image and the .I target -argument specifies the destination for the filsystem image. +argument specifies the destination for the filesystem image. If the .I source is \-, then the metadata image is read from stdin. This allows the output of
man/man8/xfs_quota.8 +1 -1
@@ -623,7 +623,7 @@ can be used to limit recursion level (\-1 is infinite, 0 is top level only, 1 is first level ... ). Option .B \-p -adds posibility to specify project paths in command line without a need +adds possibility to specify project paths in command line without a need for .I /etc/projects to exist. Note that if projects file exists then it is also used.
man/man8/xfs_repair.8 +2 -2
@@ -170,7 +170,7 @@ Verbose output. Repair dangerously. Allow .B xfs_repair to repair an XFS filesystem mounted read only. This is typically done -on a root fileystem from single user mode, immediately followed by a reboot. +on a root filesystem from single user mode, immediately followed by a reboot. .TP .B \-V Prints out the current version number and exits.
@@ -239,7 +239,7 @@ The name assigned is the inode number. aborts on most disk I/O errors. Therefore, if you are trying to repair a filesystem that was damaged due to a disk drive failure, steps should be taken to ensure that all blocks in the filesystem are -readable and writeable before attempting to use +readable and writable before attempting to use .B xfs_repair to repair the filesystem. A possible method is using .BR dd (8)
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 1/3 V2] xfsprogs: manpage spelling fixes
Sorry for being so picky. Thanks for V2!
Looks good.
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
PATCH v2 2/3 xfsprogs: Fix manpages for missing or incorrect options
In reply to Eric SandeenAdd valid options which aren't in manpages, and
remove invalid options which are in manpages:
* Document -V (show version and exit) for many manpages.
* Remove -? option from xfs_estimate.8
* Document -p passes, -d (debug) and -g (syslog) in xfs_fsr.8
* Document -n (O_NONBLOCK) in xfs_io.8
* Document -v (print overwrite) in xfs_logprint.8
* Document -m max_extents in xfs_metadump.8
* Document -p (preallocate) in xfs_mkfile.8
---
V2: move "-V" SYNOPSIS to their own line, move -V
documentation to end of option documentation list
man/man8/mkfs.xfs.8 +5 -0
@@ -40,6 +40,8 @@ mkfs.xfs \- construct an XFS filesystem .B \-K ] .I device +.br +.B mkfs.xfs \-V .SH DESCRIPTION .B mkfs.xfs constructs an XFS filesystem by writing on a special
@@ -728,6 +730,9 @@ creating the file system. .TP .B \-K Do not attempt to discard blocks at mkfs time. +.TP +.B \-V +Prints the version number and exits. .SH SEE ALSO .BR xfs (5), .BR mkfs (8),
man/man8/xfs_admin.8 +5 -0
@@ -15,6 +15,8 @@ xfs_admin \- change parameters of an XFS filesystem .I uuid ] .I device +.br +.B xfs_admin \-V .SH DESCRIPTION .B xfs_admin uses the
@@ -97,6 +99,9 @@ The may also be .BR generate , which will generate a new UUID for the filesystem. +.TP +.B \-V +Prints the version number and exits. .PP The .BR mount (8)
man/man8/xfs_bmap.8 +5 -0
@@ -10,6 +10,8 @@ xfs_bmap \- print block mapping for an XFS file .I num_extents ] .I file +.br +.B xfs_bmap \-V .SH DESCRIPTION .B xfs_bmap prints the map of disk blocks used by files in an XFS filesystem.
@@ -91,6 +93,9 @@ A second option will print out the .I flags legend. +.TP +.B \-V +Prints the version number and exits. .SH SEE ALSO .BR xfs_fsr (8), .BR xfs (5).
man/man8/xfs_check.8 +5 -0
@@ -20,6 +20,8 @@ xfs_check \- check XFS filesystem consistency .I logdev ] .I device +.br +.B xfs_check \-V .SH DESCRIPTION .B xfs_check checks whether an XFS filesystem is consistent.
@@ -89,6 +91,9 @@ Conversion between disk addresses (i.e. addresses reported by and file system blocks may be accomplished using .BR xfs_db "(8)'s " convert command. +.TP +.B \-V +Prints the version number and exits. .PP Any output that is produced when .B xfs_check
man/man8/xfs_copy.8 +5 -0
@@ -13,6 +13,8 @@ xfs_copy \- copy the contents of an XFS filesystem [ .I target2 \&... ] +.br +.B xfs_copy \-V .SH DESCRIPTION .B xfs_copy copies an XFS filesystem to one or more targets in parallel (see
@@ -87,6 +89,9 @@ Specifies the location of the if the default location of .I /var/tmp/xfs_copy.log.XXXXXX is not desired. +.TP +.B \-V +Prints the version number and exits. .SH DIAGNOSTICS .B xfs_copy reports errors to both
man/man8/xfs_db.8 +1 -1
@@ -103,7 +103,7 @@ and commands. .TP .B \-V -Prints out the current version number and exits. +Prints the version number and exits. .SH CONCEPTS .B xfs_db commands can be broken up into two classes. Most commands are for
man/man8/xfs_estimate.8 +6 -4
@@ -3,8 +3,10 @@ xfs_estimate \- estimate the space that an XFS filesystem will take .SH SYNOPSIS .nf -\f3xfs_estimate\f1 [ \f3\-h?\f1 ] [ \f3\-b\f1 blocksize ] [ \f3\-i\f1 logsize ] +\f3xfs_estimate\f1 [ \f3\-h\f1 ] [ \f3\-b\f1 blocksize ] [ \f3\-i\f1 logsize ] [ \f3\-e\f1 logsize ] [ \f3\-v\f1 ] directory ... +.br +.B xfs_estimate \-V .fi .SH DESCRIPTION For each \f2directory\f1 argument,
@@ -51,9 +53,6 @@ Display more information, formatted. .B \-h Display usage message. .TP -.B \-? -Display usage message. -.TP \f3\-i, \-e\f1 \f2logsize\f1 Use .I logsize
@@ -77,6 +76,9 @@ For example, .IP requests an estimate of the space required by the directory / on an XFS filesystem using an internal log of 1 megabyte. +.TP +.B \-V +Print the version number and exits. .SH EXAMPLES .nf .sp 8v
man/man8/xfs_freeze.8 +14 -2
@@ -2,10 +2,15 @@ .SH NAME xfs_freeze \- suspend access to an XFS filesystem .SH SYNOPSIS -.B xfs_freeze \-f +.B xfs_freeze +[ +.B \-f | .B \-u +] .I mount-point +.br +.B xfs_freeze \-V .fi .SH DESCRIPTION .B xfs_freeze
@@ -25,6 +30,7 @@ is mounted. The filesystem must be mounted to be frozen (see .BR mount (8)). .PP +.PP The .B \-f flag requests the specified XFS filesystem to be
@@ -48,7 +54,13 @@ operations to continue. Any filesystem modifications that were blocked by the freeze are unblocked and allowed to complete. .PP -One of +The +.B \-V +flag prints the version number and exits. +.PP +Unless +.B \-V +is specified, one of .B \-f or .B \-u
man/man8/xfs_fsr.8 +20 -4
@@ -3,10 +3,12 @@ xfs_fsr \- filesystem reorganizer for XFS .SH SYNOPSIS .nf -\f3xfs_fsr\f1 [\f3\-v\f1] \c -[\f3\-t\f1 seconds] [\f3\-f\f1 leftoff] [\f3\-m\f1 mtab] -\f3xfs_fsr\f1 [\f3\-v\f1] \c +\f3xfs_fsr\f1 [\f3\-vdg\f1] \c +[\f3\-t\f1 seconds] [\f3\-p\f1 passes] [\f3\-f\f1 leftoff] [\f3\-m\f1 mtab] +\f3xfs_fsr\f1 [\f3\-vdg\f1] \c [xfsdev | file] ... +.br +.B xfs_fsr \-V .fi .SH DESCRIPTION .I xfs_fsr
@@ -35,7 +37,11 @@ The default is to use .TP .BI \-t " seconds" How long to reorganize. -The default is 7200 (2 hours). +The default is 7200 seconds (2 hours). +.TP +.BI \-p " passes" +Number of passes before terminating global re-org. +The default is 10 passes. .TP .BI \-f " leftoff" Use this file instead of
@@ -47,6 +53,16 @@ to store the state of where reorganization left off. Verbose. Print cryptic information about each file being reorganized. +.TP +.B \-d +Debug. Print even more cryptic information. +.TP +.B \-g +Print to syslog (default if stdout not a tty). +.TP +.B \-V +Prints the version number and exits. + .PP When invoked with no arguments .I xfs_fsr
man/man8/xfs_growfs.8 +6 -1
@@ -15,7 +15,7 @@ xfs_growfs, xfs_info \- expand an XFS filesystem .SH SYNOPSIS .B xfs_growfs [ -.B \-dilnrxV +.B \-dilnrx ] [ .B \-D .I size
@@ -37,12 +37,17 @@ xfs_growfs, xfs_info \- expand an XFS filesystem ] .I mount-point .br +.B xfs_growfs \-V +.PP +.br .B xfs_info [ .B \-t .I mtab ] .I mount-point +.br +.B xfs_info \-V .SH DESCRIPTION .B xfs_growfs expands an existing XFS filesystem (see
man/man8/xfs_io.8 +8 -0
@@ -13,6 +13,8 @@ xfs_io \- debug the I/O path of an XFS filesystem .I prog ] .I file +.br +.B xfs_io \-V .SH DESCRIPTION .B xfs_io is a debugging tool like
@@ -52,6 +54,9 @@ is immutable or append-only. .B \-x Expert mode. Dangerous commands are only available in this mode. These commands also tend to require additional privileges. +.TP +.B \-V +Prints the version number and exits. .PP The other .BR open (2)
@@ -111,6 +116,9 @@ opens for synchronous I/O (O_SYNC). .B \-t truncates on open (O_TRUNC). .TP +.B \-n +opens in non-blocking mode if possible (O_NONBLOCK). +.TP .B \-R marks the file as a realtime XFS file after opening it, if it is not already marked as such.
man/man8/xfs_logprint.8 +6 -0
@@ -97,6 +97,12 @@ Override any notion of where to start printing. .TP .B \-t Print out the transactional view. +.TP +.B \-v +Print "overwrite" data. +.TP +.B \-V +Prints the version number and exits. .SH SEE ALSO .BR mkfs.xfs (8), .BR mount (8).
man/man8/xfs_mdrestore.8 +5 -0
@@ -8,6 +8,8 @@ xfs_mdrestore \- restores an XFS metadump image to a filesystem image ] .I source .I target +.br +.B xfs_mdrestore \-V .SH DESCRIPTION .B xfs_mdrestore is a debugging tool that restores a metadata image generated by
@@ -36,6 +38,9 @@ can be destroyed. .TP .B \-g Shows restore progress on stdout. +.TP +.B \-V +Prints the version number and exits. .SH DIAGNOSTICS .B xfs_mdrestore returns an exit code of 0 if all the metadata is successfully restored or
man/man8/xfs_metadump.8 +14 -0
@@ -6,11 +6,17 @@ xfs_metadump \- copy XFS filesystem metadata to a file [ .B \-efgow ] [ +.B \-m +.I max_extents +] +] [ .B \-l .I logdev ] .I source .I target +.br +.B xfs_metadump \-V .SH DESCRIPTION .B xfs_metadump is a debugging tool that copies the metadata from an XFS filesystem to a file.
@@ -94,12 +100,20 @@ For filesystems which use an external log, this specifies the device where the external log resides. The external log is not copied, only internal logs are copied. .TP +.B \-m +Set the maximum size of an allowed metadata extent. Extremely large metadata +extents are likely to be corrupt, and will be skipped if they exceed +this value. The default size is 1000 blocks. +.TP .B \-o Disables obfuscation of file names and extended attributes. .TP .B \-w Prints warnings of inconsistent metadata encountered to stderr. Bad metadata is still copied. +.TP +.B \-V +Prints the version number and exits. .SH DIAGNOSTICS .B xfs_metadump returns an exit code of 0 if all readable metadata is successfully copied or
man/man8/xfs_mkfile.8 +11 -0
@@ -7,10 +7,14 @@ xfs_mkfile \- create an XFS file .B \-v ] [ .B \-n +] [ +.B \-p ] .I size\c .RB [ k | b | m | g ] .IR filename " ..." +.br +.B xfs_mkfile \-V .SH DESCRIPTION .B xfs_mkfile creates one or more files. The file is padded with zeroes by default.
@@ -30,3 +34,10 @@ Verbose. Report the names and sizes of created files. .B \-n No bytes. Create a holey file - that is, do not write out any data, just seek to end of file and write a block. +.TP +.B \-p +Preallocate. The file is preallocated, then overwritten with zeroes, +then truncated to the desired size. +.TP +.B \-V +Prints the version number and exits.
man/man8/xfs_ncheck.8 +5 -0
@@ -15,6 +15,8 @@ xfs_ncheck \- generate pathnames from i-numbers for XFS .I logdev ] .I device +.br +.B xfs_ncheck \-V .SH DESCRIPTION .B xfs_ncheck with no
@@ -56,6 +58,9 @@ This option may be used to detect violations of security policy. .BI \-i " ino" Limits the report to only those files whose inode numbers follow. May be given multiple times to select multiple inode numbers. +.TP +.B \-V +Prints the version number and exits. .PP If the filesystem is seriously corrupted, or very busy and looks like it is corrupt, a message of the form that would be generated by
man/man8/xfs_quota.8 +5 -0
@@ -16,6 +16,8 @@ xfs_quota \- manage use of quota on XFS filesystems .I project ] ... [ .IR path " ... ]" +.br +.B xfs_quota \-V .SH DESCRIPTION .B xfs_quota is a utility for reporting and editing various aspects of filesystem quota.
@@ -50,6 +52,9 @@ which restricts the output of the individual commands to the set of projects specified. Multiple .B \-d arguments may be given. +.TP +.B \-V +Prints the version number and exits. .PP The optional .I path
man/man8/xfs_repair.8 +1 -1
@@ -173,7 +173,7 @@ to repair an XFS filesystem mounted read only. This is typically done on a root filesystem from single user mode, immediately followed by a reboot. .TP .B \-V -Prints out the current version number and exits. +Prints the version number and exits. .SS Checks Performed Inconsistencies corrected include the following: .IP 1.
man/man8/xfs_rtcp.8 +5 -0
@@ -10,6 +10,8 @@ xfs_rtcp \- XFS realtime copy command .B -p ] .IR source " ... " target +.br +.B xfs_rtcp \-V .SH DESCRIPTION .B xfs_rtcp copies a file to the realtime partition on an XFS filesystem.
@@ -35,6 +37,9 @@ will pad the destination file to a size which is an even multiple of the filesystem block size. This is necessary since the realtime file is created using direct I/O and the minimum I/O is the filesystem block size. +.TP +.B \-V +Prints the version number and exits. .SH SEE ALSO .BR xfs (5), .BR mkfs.xfs (8),
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
PATCH v2 3/3 xfsprogs: Fix up usage() errors and omissions
In reply to Eric SandeenAdd missing options and remove invalid options in usage() output strings.
* Add -V to several usage() strings
* Remove deprecated/invalid -n and -s otions from xfs_fsr's usage
* Remove invalid -I option from xfs_growfs's usage
* Add -n (O_NONBLOCK) option to xfs_io's usage
* Add -e (exit on error) option to xfs_logprint's usage
* Remove invalid -b option from xfs_mdrestore's usage
* Add -N (no-op), -K (no discard), and -f (force) to mkfs.xfs's usage
* Add -x (expert) option to xfs_quota's usage
---
V2: address Rich's nitpicky review ;) (i.e. fix good stuff)
copy/xfs_copy.c +1 -1
@@ -301,7 +301,7 @@ voidusage (void) {fprintf (stderr, -_ ("Usage: %s [-bd] [-L logfile] source target [target ...]\n" ), +_ ("Usage: %s [-bdV] [-L logfile] source target [target ...]\n" ), progname);exit (1 ); }
db/init.c +1 -1
@@ -43,7 +43,7 @@ static voidusage (void) {fprintf (stderr,_ ( -"Usage: %s [-fFrxV] [-p prog] [-l logdev] [-c cmd]... device\n" +"Usage: %s [-ifFrxV] [-p prog] [-l logdev] [-c cmd]... device\n" ), progname);exit (1 ); }
estimate/xfs_estimate.c +1 -0
@@ -78,6 +78,7 @@ usage(char *progname)"\t-i logsize (internal log size)\n" "\t-e logsize (external log size)\n" "\t-v prints more verbose messages\n" +"\t-V prints version and exits\n" "\t-h prints this usage message\n\n" "Note:\tblocksize may have 'k' appended to indicate x1024\n" "\tlogsize may also have 'm' appended to indicate (1024 x 1024)\n"),
fsr/xfs_fsr.c +7 -8
@@ -386,20 +386,19 @@ void usage(int ret) {fprintf (stderr,_ ( -"Usage: %s [-d] [-v] [-n] [-s] [-g] [-t time] [-p passes] [-f leftf] [-m mtab]\n" -" %s [-d] [-v] [-n] [-s] [-g] xfsdev | dir | file ...\n\n" +"Usage: %s [-d] [-v] [-g] [-t time] [-p passes] [-f leftf] [-m mtab]\n" +" %s [-d] [-v] [-g] xfsdev | dir | file ...\n" +" %s -V\n\n" "Options:\n" -" -n Do nothing, only interesting with -v. Not\n" -" effective with in mtab mode.\n" -" -s Print statistics only.\n" " -g Print to syslog (default if stdout not a tty).\n" " -t time How long to run in seconds.\n" -" -p passes Number of passes before terminating global re-org.\n" +" -p passes Number of passes before terminating global re-org.\n" " -f leftoff Use this instead of %s.\n" " -m mtab Use something other than /etc/mtab.\n" " -d Debug, print even more.\n" -" -v Verbose, more -v's more verbose.\n" - ), progname, progname, _PATH_FSRLAST); +" -v Verbose, more -v's more verbose.\n" +" -V Print version number and exit.\n" + ), progname, progname, progname, _PATH_FSRLAST);exit (ret); }
growfs/xfs_growfs.c +1 -10
@@ -19,14 +19,6 @@#include <xfs/libxfs.h> #include <xfs/path.h> -/* -* When growing a filesystem, this is the most significant -* bits we'll accept in the resulting inode numbers -* without warning the user. -*/ - -#define XFS_MAX_INODE_SIG_BITS 32 -static void usage (void ) {
@@ -37,7 +29,6 @@ Options:\n\ -l grow log section\n\ -r grow realtime section\n\ -n don't change anything, just show geometry\n\ --I allow inode numbers to exceed %d significant bits\n\ -i convert log from external to internal format\n\ -t alternate location for mount table (/etc/mtab)\n\ -x convert log from internal to external format\n\
@@ -47,7 +38,7 @@ Options:\n\ -e size set realtime extent size to size blks\n\ -m imaxpct set inode max percent to imaxpct\n\ -V print version information\n"), - progname, XFS_MAX_INODE_SIG_BITS); + progname);exit (2 ); }
io/init.c +1 -1
@@ -32,7 +32,7 @@ voidusage (void) {fprintf (stderr, -_ ("Usage: %s [-adfmrRstx] [-p prog] [-c cmd]... file\n" ), +_ ("Usage: %s [-adfmnrRstVx] [-p prog] [-c cmd]... file\n" ), progname);exit (1 ); }
io/xfs_freeze.sh +1 -1
@@ -4,7 +4,7 @@ # OPTS="" -USAGE="Usage: xfs_freeze -f | -u <mountpoint>" +USAGE="Usage: xfs_freeze [-V] [-f | -u] <mountpoint>" DIRNAME=`dirname $0` VERSION=false FREEZE=false
logprint/logprint.c +1 -0
@@ -44,6 +44,7 @@ Options:\n\ -c try to continue if error found in log\n\ -C <filename> copy the log from the filesystem to filename\n\ -d dump the log in log-record format\n\ + -e exit when an error is found in the log\n\ -f specified device is actually a file\n\ -l <device> filename of external log\n\ -n don't try and interpret log data\n\
mdrestore/xfs_mdrestore.c +1 -1
@@ -178,7 +178,7 @@ perform_restore(static void usage (void ) { -fprintf (stderr,"Usage: %s [-bg] source target\n" , progname); +fprintf (stderr,"Usage: %s [-V] [-g] source target\n" , progname);exit (1 ); }
mkfs/xfs_mkfs.c +3 -0
@@ -2899,13 +2899,16 @@ usage( void ) /* data subvol */ [-d agcount=n,agsize=n,file,name=xxx,size=num,\n\ (sunit=value,swidth=value|su=num,sw=num),\n\ sectlog=n|sectsize=num\n\ +/* force overwrite */ [-f]\n\ /* inode size */ [-i log=n|perblock=n|size=num,maxpct=n,attr=0|1|2,\n\ projid32bit=0|1]\n\ +/* no discard */ [-K]\n\ /* log subvol */ [-l agnum=n,internal,size=num,logdev=xxx,version=n\n\ sunit=value|su=num,sectlog=n|sectsize=num,\n\ lazy-count=0|1]\n\ /* label */ [-L label (maximum 12 characters)]\n\ /* naming */ [-n log=n|size=num,version=2|ci]\n\ +/* no-op info only */ [-N]\n\ /* prototype file */ [-p fname]\n\ /* quiet */ [-q]\n\ /* realtime subvol */ [-r extsize=num,size=num,rtdev=xxx]\n\
quota/init.c +1 -1
@@ -45,7 +45,7 @@ static voidusage (void) {fprintf (stderr, -_ ("Usage: %s [-p prog] [-c cmd]... [-d project]... [path]\n" ), +_ ("Usage: %s [-V] [-x] [-p prog] [-c cmd]... [-d project]... [path]\n" ), progname);exit (1 ); }
rtcp/xfs_rtcp.c +1 -1
@@ -27,7 +27,7 @@ char *progname;void usage () { -fprintf (stderr,_ ("%s [-e extsize] [-p] source target\n" ), progname); +fprintf (stderr,_ ("%s [-e extsize] [-p] [-V] source target\n" ), progname);exit (2 ); }
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 2/3 V2] xfsprogs: Fix manpages for missing or incorrect options
In reply to Eric SandeenThanks Eric for posing V2. Looks good.
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 2/3 V2] xfsprogs: Fix manpages for missing or incorrect options
In reply to Eric SandeenThanks Eric for V2, it has been committed.
--Rich
commit eaa6a2bf5940dfa5e7a295834e68f317d4686218
Author: Eric Sandeen <[email protected]> Date: Thu Apr 25 15:03:47 2013 +0000
xfsprogs: Fix manpages for missing or incorrect options
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 3/3 V2] xfsprogs: Fix up usage() errors and omissions
In reply to Eric SandeenQuoted 12 lines · Eric Sandeen
Add missing options and remove invalid options in
usage()output strings.* Add -V to several
usage()strings
* Remove deprecated/invalid -n and -s otions from xfs_fsr's usage
* Remove invalid -I option from xfs_growfs's usage
* Add -n (O_NONBLOCK) option to xfs_io's usage
* Add -e (exit on error) option to xfs_logprint's usage
* Remove invalid -b option from xfs_mdrestore's usage
* Add -N (no-op), -K (no discard), and -f (force) to mkfs.xfs's usage
* Add -x (expert) option to xfs_quota's usage
Quoted 4 lines
Signed-off-by Eric Sandeen <[email protected]>---
V2: address Rich's nitpicky review ;) (i.e. fix good stuff)
Thanks again for V2. Looks good.
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 3/3 V2] xfsprogs: Fix up usage() errors and omissions
In reply to Eric SandeenThanks Eric, this has been committed.
--Rich
commit 30626ef667746c51a6b93e21fc95eb5607c0002a
Author: Eric Sandeen <[email protected]> Date: Thu Apr 25 15:16:34 2013 +0000
xfsprogs: Fix up usage() errors and omissions
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs
Re: [PATCH 1/3 V2] xfsprogs: manpage spelling fixes
In reply to Eric SandeenThanks Eric, V2 has been committed.
--Rich
commit 87342c3a5dcb5d6812e93c201ecd3e51d971e6d6
Author: Eric Sandeen <[email protected]> Date: Thu Apr 25 14:12:08 2013 +0000
xfsprogs: manpage spelling fixes
_______________________________________________
xfs mailing list
[email protected]
http://oss.sgi.com/mailman/listinfo/xfs