Document the prdb (ubik) file format
authorBen Kaduk <kaduk@mit.edu>
Wed, 15 May 2013 15:38:53 +0000 (11:38 -0400)
committerDerrick Brashear <shadow@your-file-system.com>
Fri, 12 Jul 2013 15:06:12 +0000 (08:06 -0700)
commitaec5a1ffabefb1a81fb5c6e4ad095637aaa563c8
tree1a71bcaac933f35be1406fe71ac0fcaabdad8a77
parent3bde02595b061e4fd77f5bb453e5decca5a50d85
Document the prdb (ubik) file format

Briefly cover the ubik header and mention that it is not part of the
logical database (since it is just used for the consistency procedure).

Describe the fields of the prheader and how they are used.  Mention that
all subsequent entries are blocks of the same size, whose type can be
distinguished by a shared flags field.  User and group entries are similar,
and supergroup entries are described as a diff from regular group entries,
as only a handful of fields change.  Continuation entries can be used
for user, regular group, or supergroup entries.

Call out what fields are invariant within which classes of entry, so that
these properties can be preserved (or knowingly eliminated) for future
extensions to the format.

Change-Id: Id5ca7d8d346c09c2eec50691e5c5fefbe735ac60
Reviewed-on: http://gerrit.openafs.org/10022
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
doc/txt/prdb.txt [new file with mode: 0644]