]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: v2-format: get man output under 80 cols
authorEric Wong <e@80x24.org>
Tue, 15 Oct 2019 18:34:39 +0000 (18:34 +0000)
committerEric Wong <e@80x24.org>
Thu, 17 Oct 2019 09:51:23 +0000 (09:51 +0000)
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"

Documentation/public-inbox-v2-format.pod

index 58e6b6d318b327f68c1a089a1444b546db6828ae..10c63090721d3a238e6ec19896fb8d7ce3d8ce62 100644 (file)
@@ -20,17 +20,17 @@ databases for parallelism by "shards".
 
 =head2 INBOX OVERVIEW AND DEFINITIONS
 
 
 =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
 
 For blob lookups, the reader only needs to open the "all.git"
 repository with $GIT_DIR/objects/info/alternates which references