openafs/doc/README
Michael Meffie c6f5ebc4cf doc: relocate notes from arch to txt
The doc/txt directory has become the de facto home for text-based
technical notes. Relocate the contents of the doc/arch directory to
doc/txt. Relocate doc/examples to doc/txt/examples.

Update the doc/README file to be more current and remove old work in
progress comments.

Change-Id: Iaa53e77eb1f7019d22af8380fa147305ac79d055
Reviewed-on: https://gerrit.openafs.org/12675
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
2017-08-03 20:44:28 -04:00

23 lines
695 B
Plaintext

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.