The OpenAFS man pages are discussed on the openafs-doc mailing list at
openafs.org. If you plan on contributing to the man page project,
- please join that mailing list and send suggestions, patches, and
+ please join that mailing list and send suggestions, patches*, and
contributions there. The coordinator of the OpenAFS man page project is
Russ Allbery <rra@stanford.edu>; feel free to contact me directly with
questions (although using the mailing list is generally better and will
probably result in a faster response).
+ * Although we still accept patch submissions to the list, it is
+ greatly preferred that you make your submission through Git to
+ the OpenAFS Gerrit instance (code review system). Information
+ can be found at <http://wiki.openafs.org/GitDevelopers/>
+
POD and Man Page Generation
The OpenAFS man pages are maintained in POD (Plain Old Documentation),
Man Page Sections
The section of a man page is determined by which directory it's in.
- pod1 will be section 1 man pages, pod5 will be section 5, and pod8 will
- be section 8.
+ pod1 will be section 1 man pages, pod3 will be section 3, pod5 will be
+ section 5, and pod8 will be section 8.
The breakdown between section 1 and section 8 is fuzzy and it's hard to
get right. The current layout balances the following goals:
don't just report the deficiency again, but any contributions towards
fixing it are greatly appreciated.
- * Some of the documentation in fs getserverprefs needs minor updates to
- reflect what happens in the dynroot case.
-
- * There are lingering references to AFS Development or AFS Product
- Support in descriptions of options that one should generally not
- use. Also, all of the manual references refer to the "IBM" manual.
- We should decide how to handle this terminology-wise.
-
- * The salvager actually creates a bunch of SalvageLog files and then
- combines them, but the SalvageLog man page doesn't reflect this.
-
- * The references to the other OpenAFS manuals, such as the Quick Start
- guide and the Admin Guide, should be links, probably to the documents
- on openafs.org.
-
- * There's no mention of the Kerberos v5 support. At least, we need
- some disclaimers under klog and friends talking about sites without
- kaserver (and possibly without fakeka), and deprecation warnings
- on the .krb varient commands.
-
- * Linked cells are currently documented in fs newcell as being only
- for DCE, which is not correct. That documentation, aklog, and the
- CellServDB documentation needs to be updated.
-
* We need a way to add links to other man pages (kinit most notably)
without creating dangling links in the HTML output. This probably
means that the HTML conversion script needs to generate at startup
Changes needed to have vos suite commands completely up to date,
including the 1.5 branch:
- * Document vos listaddrs -uuid / -host, and verify docs and example for
- -printuuid
-
- * Document vos offline -busy / -sleep
-
- * Do vos online/offline support -bless/-unbless? By looking at the
- source they dont, and according to Git log that goes back to 2000
- they never did.
- According to Derrick, there was a patch to support them that vanished.
- Either the patch should be found, or bless/unbless removed from
- vos online/offline.
-
* Document vos create -minquota which is available since 1.5.61
* Document vos restore -creation/-lastupdate and -nodelete
- * Document vos delentry -noexecute. Should this option also be renamed
- to -dryrun like others?
-
Man section 8 suite commands:
* Mention bos (un)blockscanner in bos.pod text, not just in See Also
at the end
- * Update fstrace source to include option descriptions (for content,
- use existing manpage information "condensed" to half line of text)
-
* Update backup source to include option descriptions (for content,
use existing manpage information "condensed" to half line of text)
* Document backup deletedump -port/-groupid/-dbonly/-force/-noexecute
- * Replace backup diskrestore/dump -n option with -noexecute or -dryrun?
-
* Document backup help -admin
- * Document backup volrestore -usedump. Also, s/-n/.../ as above?
-
- * Replace backup volsetrestore -n option with -noexecute or -dryrun?
+ * Document backup volrestore -usedump.
If you notice other problems, please send them to the openafs-doc list
even if you don't have time to fix them. Someone else might, and we
git://git.openafs.org / openafs.git / blobdiff