openafs/doc
Andrew Deason a48e90ddf1 doc: Document fs listquota 2TB partition limit
We have previously documented that volumes over 2TB can result in
inaccuracies, but this documentation does not say how the 'partition'
field in "fs listquota" can be inaccurate. It is confusing to see a
usage of 0% for a partition that you know is being used, so try to
briefly explain in what way this field is inaccurate.

The reason we _under_-report the partition usage is that the
fileserver actually gives back PartBlocksAvail and PartMaxBlocks (not
"blocks used" and "blocks total"). So 1TB used and 4TB total is
truncated to 2TB and given back as 2TB free and 2TB total. One we hit
3TB used we'll report it as 1TB free 2TB total (50%) when the actual
usage is 75%.

Reviewed-on: http://gerrit.openafs.org/11245
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
(cherry picked from commit cd8f24d9a1)

Change-Id: I2bd72cca994414a88073d26d44bef49e9cac3be1
Reviewed-on: http://gerrit.openafs.org/11626
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Perry Ruiter <pruiter@sinenomine.net>
Reviewed-by: Chas Williams <3chas3@gmail.com>
Reviewed-by: Stephan Wiesand <stephan.wiesand@desy.de>
2015-04-15 10:18:10 -04:00
..
arch DAFS: Replace partition locks with volume locks 2010-03-17 10:29:31 -07:00
examples provide an example CellAlias file. 2002-07-16 18:39:50 +00:00
man-pages doc: Document fs listquota 2TB partition limit 2015-04-15 10:18:10 -04:00
pdf initial-pdf-with-embedded-cmr-fonts-20010606 2001-06-06 18:58:13 +00:00
protocol Add RFC 5864 to the protocol documentation directory 2010-04-21 05:59:31 -07:00
txt correct whitespace errors in readme files 2013-03-22 09:03:36 -07:00
xml doc: Fix Solaris 11 kernel module path 2013-03-22 11:10:09 -07:00
LICENSE Rework the Kerberos Autoconf probes 2010-06-15 16:30:04 -07:00
README spelling corrections in readme files 2013-03-22 02:55:59 -07:00

What's in the "doc" subdirectory

** doc/html
original IBM html doc, no longer used

** 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).  there is
some generated pdf/html content as well for the curious.

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
old Transarc (and possibly pre-Transarc) protocol and API documentation for
which we have no other source

** doc/txt
doc/examples
a few other miscellaneous files.


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.