Re: [PATCH 08/11] doc: trailer.<token>.command: refer to existing example

From: Junio C Hamano <gitster@pobox.com>
Date: May 10, 2023, 16:42 UTC
Message-ID: <xmqqfs845e98.fsf@gitster.g>
In-Reply-To: <owlyh6skmznt.fsf@fine.c.googlers.com>

Linus Arver <linusa@google.com> writes:

Show 6 quoted lines

>> At some point we may drop the
>> example, and adding a reference to the example would mean somebody
>> needs to remember removing this when it happens.
>
> Wouldn't we also delete the entire `trailer.<token>.command::` section
> (and therefore the reference to the example) also at the same time?

We could go that way.

It is likely that we'd remove text that helps for those who newly use the deprecated construct while keeping what helps for those who have to read and understand the construct that was written in random scripts they find on the Internet. So removing the example can come before the section itself, though.

In a far enough future, we would be without the example and the section so it would not be too big a deal, either way.

Thanks.