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=-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 9EF2F1F8C8;
	Sun, 19 Sep 2021 20:00:28 +0000 (UTC)
Date: Sun, 19 Sep 2021 20:00:27 +0000
From: Eric Wong <e@80x24.org>
To: Kyle Meyer <kyle@kyleam.com>
Cc: meta@public-inbox.org
Subject: Re: [PATCH 16/16] doc: lei-config: document various knobs
Message-ID: <YUeW20lbN2F7Bgjd@dcvr>
References: <20210919125035.6331-1-e@80x24.org>
 <20210919125035.6331-17-e@80x24.org>
 <87sfy08rvf.fsf@kyleam.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
In-Reply-To: <87sfy08rvf.fsf@kyleam.com>
List-Id: <meta.public-inbox.org>

Kyle Meyer <kyle@kyleam.com> wrote:
> Eric Wong writes:
> > +Call L<git-config(1> with C<$XDG_CONFIG_HOME/lei/config> as the
> 
> Looks like the ')' was unintentionally dropped.

> > +Enable protocol-level compression, this may be incompatible
> > +or broken with some servers.
> 
> nit: s/, /.  This/

> > +The any per-project .git/config, and global ~/.gitconfig files
> 
> s/The any/Any/ ?

Thanks, will squash the below.  I'll also clarify the sentence
on imap.debug vs imap.compress

diff --git a/Documentation/lei-config.pod b/Documentation/lei-config.pod
index daf66fe4..c91f36ee 100644
--- a/Documentation/lei-config.pod
+++ b/Documentation/lei-config.pod
@@ -8,7 +8,7 @@ lei config [OPTIONS]
 
 =head1 DESCRIPTION
 
-Call L<git-config(1> with C<$XDG_CONFIG_HOME/lei/config> as the
+Call L<git-config(1)> with C<$XDG_CONFIG_HOME/lei/config> as the
 configuration file.  All C<OPTIONS> are passed through, but those that
 override the configuration file are not permitted.
 
@@ -48,7 +48,7 @@ connecting to a Tor .onion or localhost.
 
 =item nntp.compress
 
-Enable protocol-level compression, this may be incompatible
+Enable protocol-level compression.  This may be incompatible
 or broken with some servers.
 
 Note: L<Net::NNTP> compression support is pending:
@@ -64,7 +64,7 @@ If using L<imap.proxy> or L<nntp.proxy> point to a SOCKS proxy,
 debugging output for L<IO::Socket::Socks> will be enabled, as
 well.
 
-Disabling L<imap.compress> may be required to improve output.
+Disabling L<imap.compress> may be required for readability.
 
 =item imap.timeout
 
@@ -96,7 +96,7 @@ C<quoted>, C<hdrdefault>, C<status>, C<attachment> color slots
 are supported for the C<-f text> and C<-f reply> output formats
 of L<lei-lcat(1)> and L<lei-q(1)>.
 
-The any per-project .git/config, and global ~/.gitconfig files
+Any per-project .git/config, and global ~/.gitconfig files
 will also be parsed for diff coloring.  git diff color slots
 (C<color.diff.SLOT>) supported are C<new>, C<old>, C<meta>,
 C<frag>, C<func>, and C<context>.