From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from relay.sgi.com (relay1.corp.sgi.com [137.38.102.111]) by oss.sgi.com (Postfix) with ESMTP id 1204F29DFA for ; Tue, 23 Apr 2013 14:36:18 -0500 (CDT) Received: from cuda.sgi.com (cuda2.sgi.com [192.48.176.25]) by relay1.corp.sgi.com (Postfix) with ESMTP id F35618F8052 for ; Tue, 23 Apr 2013 12:36:17 -0700 (PDT) Received: from sandeen.net (sandeen.net [63.231.237.45]) by cuda.sgi.com with ESMTP id zk4Ous8hMHi8VIjg for ; Tue, 23 Apr 2013 12:36:16 -0700 (PDT) Message-ID: <5176E2AF.7080201@sandeen.net> Date: Tue, 23 Apr 2013 14:36:15 -0500 From: Eric Sandeen MIME-Version: 1.0 Subject: Re: [PATCH 2/3] xfsprogs: Fix manpages for missing or incorrect options References: <5175BB8F.5090604@sandeen.net> <5175BC67.1000902@sandeen.net> <5176D46B.2030003@sgi.com> In-Reply-To: <5176D46B.2030003@sgi.com> List-Id: XFS Filesystem from SGI List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: xfs-bounces@oss.sgi.com Sender: xfs-bounces@oss.sgi.com To: Rich Johnston Cc: xfs-oss On 4/23/13 1:35 PM, Rich Johnston wrote: > 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. > 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. > ^^^^^^^^ I suppose. I'm not really sure anyone would care? > 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 not sure how I missed those, sorry. > > 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 > Regards > --Rich > > _______________________________________________ > xfs mailing list > xfs@oss.sgi.com > http://oss.sgi.com/mailman/listinfo/xfs > _______________________________________________ xfs mailing list xfs@oss.sgi.com http://oss.sgi.com/mailman/listinfo/xfs