From: Caleb White <cdwhite3@pm.me>
To: Taylor Blau <me@ttaylorr.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH] doc: consolidate extensions in git-config documentation
Date: Tue, 22 Oct 2024 17:33:52 +0000 [thread overview]
Message-ID: <D52IK8WN7D0S.2SGBXWAEE2CBZ@pm.me> (raw)
In-Reply-To: <ZxfdJs5+YbpHgpdv@nand.local>
On Tue Oct 22, 2024 at 12:13 PM CDT, Taylor Blau wrote:
> On Tue, Oct 22, 2024 at 12:08:49AM +0000, Caleb White wrote:
>> -Note that this setting should only be set by linkgit:git-init[1] or
>> -linkgit:git-clone[1]. Trying to change it after initialization will not
>> -work and will produce hard-to-diagnose issues.
>> -
>> -extensions.compatObjectFormat::
>> -
>> +--
>> +compatObjectFormat::
>
> Should this be `extensions.compatObjectFormat` instead of
> `compatObjectFormat`? I think the latter will produce awkward headings
> when these all get merged into git-config(1).
No, I built the man pages and visually inspected the changes to ensure
they were formatted correctly. This is modeled after the `advice.*`
config section which has the sub-sections listed as an indented block
under the main `advice` section. It looks like the following:
extensions.*
<description>
compatObjectFormat
<description>
<next extension>
One thing we might could do is bold the sub-sections, but the `advice.*`
section doesn't do that so I didn't do it here.
> Otherwise, looking good. Thanks for working on this!
Sure thing!
Best,
prev parent reply other threads:[~2024-10-22 17:33 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-10-22 0:08 [PATCH] doc: consolidate extensions in git-config documentation Caleb White
2024-10-22 17:13 ` Taylor Blau
2024-10-22 17:33 ` Caleb White [this message]
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=D52IK8WN7D0S.2SGBXWAEE2CBZ@pm.me \
--to=cdwhite3@pm.me \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=me@ttaylorr.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).