From 655418da783847777581ce0a5de0e781c00ef7b1 Mon Sep 17 00:00:00 2001
From: Jason Edgecombe <jason@rampaginggeek.com>
Date: Sun, 19 Aug 2007 23:27:02 +0000
Subject: [PATCH] STABLE14-man-page-fixes-20070819

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                 |  5 +++--
 doc/man-pages/check-pod              |  9 +++++++--
 doc/man-pages/pod1/vos_changeloc.pod | 12 ++++++------
 3 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/doc/man-pages/README b/doc/man-pages/README
index 8e4da53f81..7c8c5b209c 100644
--- a/doc/man-pages/README
+++ b/doc/man-pages/README
@@ -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
 
diff --git a/doc/man-pages/check-pod b/doc/man-pages/check-pod
index 2e0b24c329..640035b2c0 100755
--- a/doc/man-pages/check-pod
+++ b/doc/man-pages/check-pod
@@ -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;
diff --git a/doc/man-pages/pod1/vos_changeloc.pod b/doc/man-pages/pod1/vos_changeloc.pod
index 944610d1d2..ff40f92ff6 100644
--- a/doc/man-pages/pod1/vos_changeloc.pod
+++ b/doc/man-pages/pod1/vos_changeloc.pod
@@ -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