Michael Schroeder wrote:
On Tue, Jun 18, 2013 at 05:31:27PM +0200, Stephan Kulow wrote:
On 18.06.2013 16:58, Jan Engelhardt wrote:
On Tuesday 2013-06-18 12:56, Stephan Kulow wrote:
The one from wget is funny:
wget.pod around line 2105: Expected text after =item, not a number
And indeed, wget.pod contains "=item 0", "=item 1", etc. But that is a normal thing, because it describes the exit codes. FWIW, the 0 is meant as text. I smell an overjealous new check inside the POD reader.
It probably should be written as:
=item C<0>
That's not "probably should be", but "must be". :-) There's an alternative, you can use "=item B<0>". Then the exit code is in boldface which is readable as well.
Hmm, http://perldoc.perl.org/perlpod.html even recommends using numbers
It recommends "1.", "2.", note the period at the end of the number.
You *must not* use "1.", "2.", for describing exit codes in POD. That's POD's way to demand a numbered list with pseudo-markup. POD will complain if the numbers are not incremented by one, the complain will be in the generated man page. (Up to Perl 5.8, POD did ignore the numbers completely and generated some of its own.) I.e., =item 0. =item 1. =item 4. in such a man page will get you a nice section at the man page's end that your markup is wrong. Not something you want, probably. ;-) Joachim -- =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- Joachim Schrod, Roedermark, Germany Email: jschrod@acm.org -- To unsubscribe, e-mail: opensuse-factory+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-factory+owner@opensuse.org