git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Taylor Blau <me@ttaylorr.com>
To: Derrick Stolee <stolee@gmail.com>
Cc: Andrei Rybak <rybak.a.v@gmail.com>,
	git@vger.kernel.org, dstolee@microsoft.com
Subject: Re: [PATCH] config doc: indent descriptions of feature.* variables
Date: Wed, 2 Jun 2021 12:59:39 -0400	[thread overview]
Message-ID: <YLe4+2JKH1LYRTvv@nand.local> (raw)
In-Reply-To: <057126a2-81c4-41cf-e41a-52a24a0c9a52@gmail.com>

On Tue, Jun 01, 2021 at 09:17:54PM -0400, Derrick Stolee wrote:
> On 6/1/2021 8:11 PM, Andrei Rybak wrote:
> > Config variables feature.experimental and feature.manyFiles are grouped
> > together under "feature.*".  However, this is not easily visible when
> > scanning the help page of git-config.
> >
> > Indent the descriptions of individual feature.* config variables to help
> > the reader distinguish this group of variables.
>
> I'm not sure how these extra tabs help in the rendered text, or in
> the formatted HTML output for the git-scm.com web page. I do believe
> that we would want to re-wrap the paragraphs to ensure we are not using
> too many characters per line.
>
> Is there precedence for a simple tabbing like this? I was able to find
> a similar grouping for advice.* in Documentation/config/advice.txt, but
> it uses a different kind of grouping. Perhaps reorganize the file to use
> that strategy instead?

AsciiDoc has a couple of ways to indent a subsection, one example (which
uses the same style '--' header as in these patches) can be found in
9218c6a40c (midx: allow marking a pack as preferred, 2021-03-30).

> Or, perhaps just point me to an existing use of this pattern.

git-scm.com doesn't have 9218c6a40c yet, since it won't be released
until 2.32, but grepping around for '^--' in Documentation shows some
other results.

Thanks,
Taylor

  reply	other threads:[~2021-06-02 16:59 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-02  0:11 [PATCH] config doc: indent descriptions of feature.* variables Andrei Rybak
2021-06-02  1:14 ` Đoàn Trần Công Danh
2021-06-02  1:17 ` Derrick Stolee
2021-06-02 16:59   ` Taylor Blau [this message]
2021-06-02 20:38     ` Todd Zullinger
2021-06-02 23:04       ` Felipe Contreras
2021-06-03  7:02 ` Ævar Arnfjörð Bjarmason
2021-06-03  7:43   ` Ævar Arnfjörð Bjarmason
2021-06-03 18:03     ` Felipe Contreras

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=YLe4+2JKH1LYRTvv@nand.local \
    --to=me@ttaylorr.com \
    --cc=dstolee@microsoft.com \
    --cc=git@vger.kernel.org \
    --cc=rybak.a.v@gmail.com \
    --cc=stolee@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).