jimzah/openafs
1
0
Fork 0
mirror of https://git.openafs.org/openafs.git synced 2025-01-18 23:10:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

STABLE14-man-page-fixes-20070819

Browse Source 
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 dfb2961b67)
This commit is contained in:
Jason Edgecombe 2007-08-19 23:27:02 +00:00 committed by Russ Allbery
parent ddde0c6c46
commit 655418da78
3 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/man-pages/README
View 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

9
doc/man-pages/check-pod
View File

@ -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;

12
doc/man-pages/pod1/vos_changeloc.pod
View 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