diff --git a/doc/man-pages/README b/doc/man-pages/README index 20d449c985..93b6b15106 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -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 diff --git a/doc/man-pages/check-pod b/doc/man-pages/check-pod index 2e0b24c329..640035b2c0 100755 --- a/doc/man-pages/check-pod +++ b/doc/man-pages/check-pod @@ -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; diff --git a/doc/man-pages/pod1/vos_changeloc.pod b/doc/man-pages/pod1/vos_changeloc.pod index 944610d1d2..ff40f92ff6 100644 --- a/doc/man-pages/pod1/vos_changeloc.pod +++ b/doc/man-pages/pod1/vos_changeloc.pod @@ -7,15 +7,15 @@ vos changeloc - Change a volume's entry in the VLDB =for html