DEVEL15-man-page-fixes-20070819
authorJason Edgecombe <jason@rampaginggeek.com>
Sun, 19 Aug 2007 23:20:43 +0000 (23:20 +0000)
committerRuss Allbery <rra@stanford.edu>
Sun, 19 Aug 2007 23:20:43 +0000 (23:20 +0000)
More details on how to run check-pod.  Restore the [] markup in the vos
changeloc SYNOPSIS since the flags really are optional.

(cherry picked from commit dfb2961b677299a726be33e63b29476f003d03a7)

doc/man-pages/README
doc/man-pages/check-pod
doc/man-pages/pod1/vos_changeloc.pod

index 8e4da53..7c8c5b2 100644 (file)
@@ -186,8 +186,9 @@ How You Can Help
   bugs.
 
   You can test your new POD documentation by running the check-pod script
-  in this directory.  (And check other people's documentation and find any
-  problems that have crept in.)
+  in this directory with "prove check-pod".  (And check other people's
+  documentation and find any problems that have crept in.)  You will need
+  to have Test::Pod installed.
 
 Known Problems
 
index 2e0b24c..640035b 100755 (executable)
@@ -1,7 +1,12 @@
 #!/usr/bin/perl
 #
-# Written by Jason Edgecombe based on the Test::Pod documentation.  Run
-# it to syntax-check all of the POD files.
+# Written by Jason Edgecombe based on the Test::Pod documentation.  The
+# best way to run it is to run:
+#
+#     prove check-pod
+#
+# from the doc/man-pages directory, which will show any errors found in
+# any of the POD files.
 
 use strict;
 use Test::More;
index 944610d..ff40f92 100644 (file)
@@ -7,15 +7,15 @@ vos changeloc - Change a volume's entry in the VLDB
 =for html
 <div class="synopsis">
 
-B<vos changeloc> S<<< B<-server> <I<new server name>> >>>
-   S<<< B<-partition> <I<new partition location>> >>>
-   S<<< B<-id> <I<volume name or ID>> >>>
+B<vos changeloc> S<<< [B<-server>] <I<new server name>> >>>
+   S<<< [B<-partition>] <I<new partition location>> >>>
+   S<<< [B<-id>] <I<volume name or ID>> >>>
    S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
    [B<-verbose>] [B<-encrypt>] [B<-help>]
 
-B<vos changel> S<<< B<-s> <I<new server name>> >>>
-   S<<< B<-p> <I<new partition location>> >>>
-   S<<< B<-i> <I<volume name or ID>> >>>
+B<vos changel> S<<< [B<-s>] <I<new server name>> >>>
+   S<<< [B<-p>] <I<new partition location>> >>>
+   S<<< [B<-i>] <I<volume name or ID>> >>>
    S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-v>] [B<-e>] [B<-h>]
 
 =for html