Add include method for POD documentation
authorRuss Allbery <rra@stanford.edu>
Fri, 16 Jul 2010 00:21:26 +0000 (17:21 -0700)
committerDerrick Brashear <shadow@dementia.org>
Fri, 16 Jul 2010 04:09:13 +0000 (21:09 -0700)
commita792acdadc8fe6e7354be4c23e60c795b3b4f109
tree843cf5375a313b41ab43250c143ce6e51e47b8f2
parent3e2c3c9a56fbffd0dc63183dcb053f942b6a2bf6
Add include method for POD documentation

Add a preprocessor for POD documentation that handles a custom
=include directive.  Demonstrate how to use the preprocessor by
factoring out all the standard PTS options into a separate POD
fragment and including that fragment in all the PTS commands that
take the standard options instead of including that documentation
in each separate file.

Change-Id: If5255efc6d3fc670b38a9898b3d7d3c60af04fcf
Reviewed-on: http://gerrit.openafs.org/2440
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
23 files changed:
doc/man-pages/check-pod
doc/man-pages/merge-pod [new file with mode: 0755]
doc/man-pages/pod1/.gitignore [new file with mode: 0644]
doc/man-pages/pod1/fragments/pts-common.pod [new file with mode: 0644]
doc/man-pages/pod1/pts_adduser.pod.in [moved from doc/man-pages/pod1/pts_adduser.pod with 80% similarity]
doc/man-pages/pod1/pts_chown.pod.in [moved from doc/man-pages/pod1/pts_chown.pod with 79% similarity]
doc/man-pages/pod1/pts_creategroup.pod.in [moved from doc/man-pages/pod1/pts_creategroup.pod with 90% similarity]
doc/man-pages/pod1/pts_createuser.pod.in [moved from doc/man-pages/pod1/pts_createuser.pod with 89% similarity]
doc/man-pages/pod1/pts_delete.pod.in [moved from doc/man-pages/pod1/pts_delete.pod with 79% similarity]
doc/man-pages/pod1/pts_examine.pod.in [moved from doc/man-pages/pod1/pts_examine.pod with 92% similarity]
doc/man-pages/pod1/pts_interactive.pod.in [moved from doc/man-pages/pod1/pts_interactive.pod with 82% similarity]
doc/man-pages/pod1/pts_listentries.pod.in [moved from doc/man-pages/pod1/pts_listentries.pod with 79% similarity]
doc/man-pages/pod1/pts_listmax.pod.in [moved from doc/man-pages/pod1/pts_listmax.pod with 72% similarity]
doc/man-pages/pod1/pts_listowned.pod.in [moved from doc/man-pages/pod1/pts_listowned.pod with 84% similarity]
doc/man-pages/pod1/pts_membership.pod.in [moved from doc/man-pages/pod1/pts_membership.pod with 91% similarity]
doc/man-pages/pod1/pts_quit.pod.in [moved from doc/man-pages/pod1/pts_quit.pod with 69% similarity]
doc/man-pages/pod1/pts_removeuser.pod.in [moved from doc/man-pages/pod1/pts_removeuser.pod with 80% similarity]
doc/man-pages/pod1/pts_rename.pod.in [moved from doc/man-pages/pod1/pts_rename.pod with 82% similarity]
doc/man-pages/pod1/pts_setfields.pod.in [moved from doc/man-pages/pod1/pts_setfields.pod with 91% similarity]
doc/man-pages/pod1/pts_setmax.pod.in [moved from doc/man-pages/pod1/pts_setmax.pod with 76% similarity]
doc/man-pages/pod1/pts_sleep.pod.in [moved from doc/man-pages/pod1/pts_sleep.pod with 72% similarity]
doc/man-pages/pod1/pts_source.pod.in [moved from doc/man-pages/pod1/pts_source.pod with 67% similarity]
regen.sh