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.

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>
(cherry picked from commit e3fb2740ba20e78fdc93308b6a2843454a6d269c)

Change-Id: I1ef65090d5449f600ef03171436a27c142e69fbb
Reviewed-on: http://gerrit.openafs.org/9563
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Andrew Deason <adeason@sinenomine.net>
Reviewed-by: Stephan Wiesand <stephan.wiesand@desy.de>

diff --git a/doc/man-pages/pod8/volinfo.pod b/doc/man-pages/pod8/volinfo.pod
index 5215428b504c0f2dd7b852246466b455a1e12dc2..e9946565d31350034fa64c13ee0a73ac14e426e4 100644 (file)
--- 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 a1ab3d35ec43600777449839f717e968ca2e37f2..e009d0bd7094f89e19bc88e15d5fc2769a51491b 100644 (file)
--- a/src/vol/vol-info.c
+++ b/src/vol/vol-info.c
@@ -626,7 +626,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,
@@ -643,7 +643,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;