mirror of
https://git.openafs.org/openafs.git
synced 2025-01-18 15:00:12 +00:00
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>
This commit is contained in:
parent
57d32c2914
commit
c6f5ebc4cf
56
doc/README
56
doc/README
@ -1,58 +1,22 @@
|
|||||||
What's in the "doc" subdirectory
|
What's in the "doc" subdirectory
|
||||||
|
|
||||||
** doc/html
|
|
||||||
original IBM html doc, no longer used
|
|
||||||
|
|
||||||
** doc/man-pages
|
** doc/man-pages
|
||||||
pod sources for man pages (converted from original IBM html source).
|
pod sources for man pages (converted from original IBM html source).
|
||||||
|
|
||||||
** doc/xml
|
** doc/xml
|
||||||
xml sources for manuals (converted from original IBM html source). there is
|
xml sources for manuals (converted from original IBM html source).
|
||||||
some generated pdf/html content as well for the curious.
|
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.
|
||||||
Note that doc/xml/AdminReference uses doc/xml/AdminReference/pod2refentry to
|
|
||||||
convert the pod man pages to xml for printing. pod goes directly to html
|
|
||||||
just fine.
|
|
||||||
|
|
||||||
The reference guide is now built by converting the existing pod documentation
|
|
||||||
to xml. however, the indexing information was lost during the initial pod
|
|
||||||
conversion. Someone we will need to try to get that back.
|
|
||||||
|
|
||||||
** doc/pdf
|
** doc/pdf
|
||||||
old Transarc (and possibly pre-Transarc) protocol and API documentation for
|
Old Transarc (and possibly pre-Transarc) protocol and API documentation for
|
||||||
which we have no other source
|
which we have no other source.
|
||||||
|
|
||||||
** doc/txt
|
** doc/txt
|
||||||
doc/examples
|
Technical notes, Windows notes, and examples.
|
||||||
a few other miscellaneous files.
|
|
||||||
|
|
||||||
|
** 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.
|
||||||
|
|
||||||
From: Russ Allbery
|
|
||||||
|
|
||||||
The Administrative Reference has been converted into separate POD man pages
|
|
||||||
for each command, since that's basically what it already was (just in HTML).
|
|
||||||
Considerable work remains to update that POD documentation to reflect the
|
|
||||||
current behavior of OpenAFS (for example, there's no documentation of
|
|
||||||
dynroot, no mention of Kerberos v5, many fileserver options are
|
|
||||||
undocumented, the afsd switch documentation is out of date, and so forth).
|
|
||||||
I've collected as many of those deficiencies as I know of in
|
|
||||||
doc/man-pages/README. Any contributions to correct any of those deficiencies
|
|
||||||
are very welcome. This is one easy place to start.
|
|
||||||
|
|
||||||
The other reference manuals (the Administrator's Guide, the Quick Start
|
|
||||||
Guide, and the User's Guide) are more manual-like in their structure. After
|
|
||||||
some on-list discussion, we picked DocBook as the format to use going
|
|
||||||
forward and the existing HTML files have been converted to DocBook with a
|
|
||||||
script. This means that the markup could use a lot of cleaning up and the
|
|
||||||
content is even less updated than the man pages.
|
|
||||||
|
|
||||||
I did some *very* initial work on the Quick Start Guide, just to get the
|
|
||||||
makefile working and to try some simple modifications. Simon Wilkinson is
|
|
||||||
currently working on making more extensive modifications. If you want to
|
|
||||||
work on the Quick Start Guide, please coordinate with him to avoid duplicate
|
|
||||||
work.
|
|
||||||
|
|
||||||
The Administrator's Guide and User's Guide have not yet been touched. Of
|
|
||||||
those, the latter is probably in the best shape, in that the user commands
|
|
||||||
and behavior haven't changed as much. If you'd like to start working on one
|
|
||||||
of those, that would also be great.
|
|
||||||
|
Loading…
Reference in New Issue
Block a user