[OpenAFS-Doc] POD error?

Russ Allbery rra@stanford.edu
Wed, 18 May 2011 15:17:34 -0700


Jeff Blaine <jblaine@kickflop.net> writes:

> Before I muck something up, just bear with me as I
> immerse myself in this stuff and get up to speed...

> Is there a reason there's no closing >>> on the 2nd
> to last line below?

> B<vos delentry> S<<< [B<-id> <I<volume name or ID>>+] >>>
>    S<<< [B<-prefix> <I<prefix of volume whose VLDB entry is to be
> deleted>>] >>>
>     S<<< [B<-server> <I<machine name>>] >>>
>     S<<< [B<-partition> <I<partition name>>] >>>
>     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
>     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]

The closing >>> is after the I<cell name> argument.  The S<> is
surrounding an option with an argument so that they won't be split across
multiple lines, which makes them harder to read.

For a new flag without any arguments, you can just add it as [B<-dryrun>]
like the other regular flags.

-- 
Russ Allbery (rra@stanford.edu)             <http://www.eyrie.org/~eagle/>