openafs/doc
Michael Meffie 6ff968264f doc: Sort man page entries in AdminRef
The AdminRef is a collection of OpenAFS man pages in a single document.
Unfortunately, the man pages are not listed in any particular order, but
rather just the order found by reading the unsorted directory entries.

Change the generate-xml script so the man pages are in sorted order in
the generated AdminRef document.  Instead of writing the man page
references after processing each page, save each entry in a list, and
then sort the list after all the pages have been processed.

Also, check the exit code of the pod2refentry script so errors are not
ignored while generating the AdminRef document.

Change-Id: I624485e4efd1fb0c08642b379a12c946f5793336
Reviewed-on: https://gerrit.openafs.org/15827
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Cheyenne Wills <cwills@sinenomine.net>
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
2024-09-12 12:45:29 -04:00
..
doxygen JAVA: remove unsupported JAVA component 2024-06-13 12:18:15 -04:00
man-pages man-pages: Add a batch mode to merge-pod 2024-08-12 14:44:31 -04:00
pdf initial-pdf-with-embedded-cmr-fonts-20010606 2001-06-06 18:58:13 +00:00
protocol Remove almost all bcopy/bzero/bcmp calls 2024-06-28 14:23:42 -04:00
txt prdb.txt: correct fixed header length 2021-10-28 00:56:26 -04:00
xml doc: Sort man page entries in AdminRef 2024-09-12 12:45:29 -04:00
LICENSE Rework the Kerberos Autoconf probes 2010-06-15 16:30:04 -07:00
README doc: relocate notes from arch to txt 2017-08-03 20:44:28 -04:00

What's in the "doc" subdirectory

** doc/man-pages
pod sources for man pages (converted from original IBM html source).

** doc/xml
xml sources for manuals (converted from original IBM html source).
Note: The doc/xml/AdminRef uses doc/xml/AdminRef/pod2refentry to convert the
pod man pages to xml for printing.  pod goes directly to html just fine.

** doc/pdf
Old Transarc (and possibly pre-Transarc) protocol and API documentation for
which we have no other source.

** doc/txt
Technical notes, Windows notes, and examples.

** doc/doxygen
Configuration files for the doxygen tool to generate documentation from
the annotated sources. See the 'dox' Makefile target in the top level
Makefile.