From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <e@80x24.org>
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=-3.9 required=3.0 tests=ALL_TRUSTED,AWL,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 4B5E91F4BE;
	Mon,  7 Oct 2019 20:52:04 +0000 (UTC)
Date: Mon, 7 Oct 2019 20:52:04 +0000
From: Eric Wong <e@80x24.org>
To: Alyssa Ross <hi@alyssa.is>
Cc: meta@public-inbox.org
Subject: Re: [PATCH] public-inbox-v2-format(5): fix formatting
Message-ID: <20191007205204.GA28120@dcvr>
References: <20191007202725.16802-1-hi@alyssa.is>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
In-Reply-To: <20191007202725.16802-1-hi@alyssa.is>
List-Id: <meta.public-inbox.org>

Alyssa Ross <hi@alyssa.is> wrote:
> This was being rendered as a paragraph, so line breaks weren't
> preserved and it was unreadable in man.

Thanks for noticing that, it's obvious I never really looked at
the result :x  (and I'm writing a new .pod right now, too)

> diff --git a/Documentation/public-inbox-v2-format.pod b/Documentation/public-inbox-v2-format.pod
> index 28d3550..58e6b6d 100644
> --- a/Documentation/public-inbox-v2-format.pod
> +++ b/Documentation/public-inbox-v2-format.pod
> @@ -24,13 +24,13 @@ $EPOCH - Integer starting with 0 based on time
>  $SCHEMA_VERSION - PublicInbox::Search::SCHEMA_VERSION used by Xapian
>  $PART - Integer (0..NPROCESSORS)

Looks like the lines preceding this patch need to be indented to
preserve newlines, too.

> -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
> +	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

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 :<