From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 6B6991F4C0; Tue, 15 Oct 2019 20:11:44 +0000 (UTC) Date: Tue, 15 Oct 2019 20:11:44 +0000 From: Eric Wong To: meta@public-inbox.org Cc: Alyssa Ross Subject: [PATCH 2/1] doc: v2-format: get man output under 80 cols Message-ID: <20191015201144.GA31635@dcvr> References: <20191007202725.16802-1-hi@alyssa.is> <20191007205204.GA28120@dcvr> <87o8ys5keu.fsf@alyssa.is> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <87o8ys5keu.fsf@alyssa.is> List-Id: Alyssa Ross wrote: > > I noticed both the original and post-patch manpage exceeds the > > limits of an 80-column terminal. I think it's worth it to > > reflow and perhaps reword to ensure folks who are limited to 80 > > columns can viwe (but I can take care of it, too, if you're busy) > > > > Even fitting 80 columns on my screen is a challenge with the > > giant fonts I need to workaround poor eyesight :< > > I appreciate your commitment! I think you'd be a better judge of how > to format it nicely than me. :) I'll apply this on top of your patch since there's wording changes, too: ------8<---- Subject: [PATCH] doc: v2-format: get man output under 80 cols 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 | 22 +++++++++++----------- 1 file 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