[OpenAFS-Doc] doc testing script

[Jason Edgecombe]

Hi,

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.

Sincerely,
Jason

[Russ Allbery]

Post by Jason Edgecombe
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!

[Jason Edgecombe]

Post by Russ Allbery

Post by Jason Edgecombe
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

Jason

[Russ Allbery]

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

Yeah, that's always a problem. Feel free to ask on this list; sometimes I
can take a few moments to dig out information or reply with something from
memory, and that's still faster than writing the man page myself. And
that may be the case for others as well.

kseal is a debugging program that I'm not sure we should even be
installing. The right solution for it may be to just change the Makefile
to not install it. You give it the username and the pre-salted password
for the AFS service key on the command line and it creates an AFS token
for you. It lets you "forge" an AFS token with knowledge of the AFS
service ticket key without talking to a Kerberos server.

[Jason Edgecombe]

Post by Jason Edgecombe

Post by Russ Allbery

Post by Jason Edgecombe
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

[Russ Allbery]

Post by Jason Edgecombe
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.

You did mention -- I just forgot to include that in the README or in the
comment. Thanks, I'll do that. I didn't know about prove before.

[Jason Edgecombe]

Post by Russ Allbery

Post by Jason Edgecombe
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.

You did mention -- I just forgot to include that in the README or in the
comment. Thanks, I'll do that. I didn't know about prove before.

cool.

FYI, the prove command is a perl command to run a perl unit test. The
check-pod script is a unit test for documentation. The check-pod script
prints out the results in Perl's TAP (Test Anything Protocol) which is
consumed and summarized by the "prove" command.

I learned this from the Perl Testing Developer's Notebook from O'Reilly.
I highly recommend it.

Jason