Re: [PATCH] doc: consolidate extensions in git-config documentation

From: Caleb White <cdwhite3@pm.me>
Date: Oct 22, 2024, 17:33 UTC
Message-ID: <D52IK8WN7D0S.2SGBXWAEE2CBZ@pm.me>
In-Reply-To: <ZxfdJs5+YbpHgpdv@nand.local>

On Tue Oct 22, 2024 at 12:13 PM CDT, Taylor Blau wrote:

Show 13 quoted lines

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