From: Michael Meffie <mmeffie@sinenomine.net>
Date: Fri, 20 May 2011 17:53:48 +0000 (-0400)
Subject: doc: document volinfo -filenames option
X-Git-Tag: openafs-devel-1_7_1~479
X-Git-Url: http://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=e3fb2740ba20e78fdc93308b6a2843454a6d269c

doc: document volinfo -filenames option

Add the namei -filenames option to the volinfo man page.

Note this option as implemented implies the -vnode flag, but for
consistency with the other fields that modify the default mode
output, it is documented to be accompany the -vnode flag.

Change-Id: I7cc5cdf5e74e65ca25ecc086e550a468b803b971
Reviewed-on: http://gerrit.openafs.org/4690
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Tested-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
---

diff --git a/doc/man-pages/pod8/volinfo.pod b/doc/man-pages/pod8/volinfo.pod
index 5215428..e994656 100644
--- a/doc/man-pages/pod8/volinfo.pod
+++ b/doc/man-pages/pod8/volinfo.pod
@@ -10,7 +10,7 @@ volinfo - Produces detailed statistics about AFS volume headers
 B<volinfo> [B<-online>] [B<-vnode>] [B<-date>] [B<-inode>] [B<-itime>]
     S<<< [B<-part> <I<AFS partition name (default current partition)>>+] >>>
     S<<< [B<-volumeid> <I<volume id>>+] >>> [B<-header>] [B<-sizeOnly>]
-    [B<-fixheader>] [B<-saveinodes>] [B<-orphaned>] [B<-help>]
+    [B<-fixheader>] [B<-saveinodes>] [B<-orphaned>] [B<-filenames>] [B<-help>]
 
 =for html
 </div>
@@ -100,6 +100,13 @@ Displays a large vnode and small vnode table for each volume, which lists
 only orphaned vnodes (vnodes that have no parent). If there are none, the
 tables are empty (only the headers appear).
 
+=item B<-filenames>
+
+When combined with the B<-vnode> flag, adds the full path and file name of the
+C<namei> file which stores the vnode data to each vnode entry in the large vnode
+and small vnode tables. This option is only available on fileservers which use
+the C<namei> storage format for storing data.
+
 =item B<-help>
 
 Prints the online help for this command. All other valid options are
diff --git a/src/vol/vol-info.c b/src/vol/vol-info.c
index 9016048..432b55f 100644
--- a/src/vol/vol-info.c
+++ b/src/vol/vol-info.c
@@ -598,7 +598,7 @@ main(int argc, char **argv)
     cmd_AddParm(ts, "-date", CMD_FLAG, CMD_OPTIONAL,
 		"Also dump vnode's mod date");
     cmd_AddParm(ts, "-inode", CMD_FLAG, CMD_OPTIONAL,
-		"Dump vnode's inode number");
+		"Also dump vnode's inode number");
     cmd_AddParm(ts, "-itime", CMD_FLAG, CMD_OPTIONAL,
 		"Dump special inode's mod times");
     cmd_AddParm(ts, "-part", CMD_LIST, CMD_OPTIONAL,
@@ -615,7 +615,7 @@ main(int argc, char **argv)
     cmd_AddParm(ts, "-orphaned", CMD_FLAG, CMD_OPTIONAL,
 		"List all dir/files without a parent");
 #if defined(AFS_NAMEI_ENV)
-    cmd_AddParm(ts, "-filenames", CMD_FLAG, CMD_OPTIONAL, "Print filenames");
+    cmd_AddParm(ts, "-filenames", CMD_FLAG, CMD_OPTIONAL, "Also dump vnode's namei filename");
 #endif
     code = cmd_Dispatch(argc, argv);
     return code;