Re: [PATCH 1/5] backfill: add builtin boilerplate

From: Junio C Hamano <gitster@pobox.com>
Date: Jan 16, 2025, 17:52 UTC
Message-ID: <xmqqfrlisl23.fsf@gitster.g>
In-Reply-To: <Z4jbW7UtaC7hQU1Z@pks.im>

Patrick Steinhardt <ps@pks.im> writes:

Show 22 quoted lines

> On Fri, Dec 06, 2024 at 08:07:14PM +0000, Derrick Stolee via GitGitGadget wrote:
>> diff --git a/Documentation/git-backfill.txt b/Documentation/git-backfill.txt
>> new file mode 100644
>> index 00000000000..640144187d3
>> --- /dev/null
>> +++ b/Documentation/git-backfill.txt
>> @@ -0,0 +1,23 @@
>> +git-backfill(1)
>> +===============
>> +
>> +NAME
>> +----
>> +git-backfill - Download missing objects in a partial clone
>> +
>> +
>> +SYNOPSIS
>> +--------
>> +[verse]
>> +'git backfill' [<options>]
>
> Ah, one thing I forgot about: this could use the new `[synopsis]` style,
> which removes some need for formatting directives.

Yeah, I thought it was more or less simultaneous development and it was OK to convert after the dust settles, but it seems to predate the series by 3 months.

$ git show -s --format=reference 029eff9e34f 375852e20 029eff9e34 (doc: update the guidelines to reflect the current formatting rules, 2024-09-24) 375852e20f (backfill: add builtin boilerplate, 2024-12-20)

ds/backfill:Documentation/CodingGuidelines does tell us '[synopsis]' is available, even ;-)

Thanks for noticing.