diff options
| author | Eric Wong <e@80x24.org> | 2019-10-15 18:34:39 +0000 |
|---|---|---|
| committer | Eric Wong <e@80x24.org> | 2019-10-17 09:51:23 +0000 |
| commit | 77dc49f8978467f318192feccf067745328a1d82 (patch) | |
| tree | 1478cdbd1e058d091cf2fb385e528c872a3582fc /Documentation | |
| parent | 6f43429b7722412373043e84757f55a533f94e10 (diff) | |
| download | public-inbox-77dc49f8978467f318192feccf067745328a1d82.tar.gz | |
We need to better ensure our manpage output is readable with a standard terminal width. And fix some wording while we're at it: * use "inbox" instead of "list" for our storage * replace the last "$PART" reference with "$SHARD"
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/public-inbox-v2-format.pod | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/Documentation/public-inbox-v2-format.pod b/Documentation/public-inbox-v2-format.pod index 58e6b6d3..10c63090 100644 --- a/Documentation/public-inbox-v2-format.pod +++ b/Documentation/public-inbox-v2-format.pod @@ -20,17 +20,17 @@ databases for parallelism by "shards". =head2 INBOX OVERVIEW AND DEFINITIONS -$EPOCH - Integer starting with 0 based on time -$SCHEMA_VERSION - PublicInbox::Search::SCHEMA_VERSION used by Xapian -$PART - Integer (0..NPROCESSORS) - - foo/ # assuming "foo" is the name of the list - - inbox.lock # lock file (flock) to protect global state - - git/$EPOCH.git # normal git repositories - - all.git # empty git repo, alternates to git/$EPOCH.git - - xap$SCHEMA_VERSION/$SHARD # per-shard Xapian DB - - xap$SCHEMA_VERSION/over.sqlite3 # OVER-view DB for NNTP and threading - - msgmap.sqlite3 # same the v1 msgmap + $EPOCH - Integer starting with 0 based on time + $SCHEMA_VERSION - DB schema version (for Xapian) + $SHARD - Integer starting with 0 based on parallelism + + foo/ # "foo" is the name of the inbox + - inbox.lock # lock file to protect global state + - git/$EPOCH.git # normal git repositories + - all.git # empty, alternates to $EPOCH.git + - xap$SCHEMA_VERSION/$SHARD # per-shard Xapian DB + - xap$SCHEMA_VERSION/over.sqlite3 # OVER-view DB for NNTP, threading + - msgmap.sqlite3 # same the v1 msgmap For blob lookups, the reader only needs to open the "all.git" repository with $GIT_DIR/objects/info/alternates which references |