[OpenAFS-Doc] doc testing script
Jason Edgecombe
jason@rampaginggeek.com
Fri, 17 Aug 2007 23:09:07 -0400
Jason Edgecombe wrote:
> Russ Allbery wrote:
>> Jason Edgecombe <jason@rampaginggeek.com> writes:
>>
>>
>>> Here is a quick perl script called testpod that uses the Test::Pod perl
>>> module. Run it using "prove testpod" and it will display all of the pod
>>> syntax errors in the pod documenation. I copied it from the Test::Pod
>>> documentation and changed a couple of lines.
>>>
>>
>> I've committed this to the repository for ease of use. Thanks!
>>
>>
> You're welcome.
>
> You need to install the Test::Pod Perl module in order to use it, and
> it should be run from within the doc/man-pages directory.
>
> FYI, I'm still working on documentation. I've just been busier lately
> and I'm having trouble finding out what things do and how to use them.
> kseal is an example of this
I forgot to mention. The easiest way to run the script is "prove
check-pod" This just shows the errors or "ok" for the bundle as opposed
to listing each file.
Jason