Re: [PATCH v2] SubmittingPatches: release-notes entry experiment

From: Phillip Wood <phillip.wood123@gmail.com>
Date: Mar 26, 2024, 14:18 UTC
Message-ID: <dda1ba52-7b43-4017-96e7-10080618d4e7@gmail.com>
In-Reply-To: <xmqq8r26eyva.fsf@gitster.g>

Hi Junio

On 25/03/2024 22:21, Junio C Hamano wrote:

Show 14 quoted lines

> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> index e734a3f0f1..e29a3d9a5b 100644
> --- a/Documentation/SubmittingPatches
> +++ b/Documentation/SubmittingPatches
> @@ -459,6 +459,17 @@ an explanation of changes between each iteration can be kept in
>   Git-notes and inserted automatically following the three-dash
>   line via `git format-patch --notes`.
>   
> +[[a-paragraph-summary]]
> +
> +*This is EXPERIMENTAL*.  When sending a topic, you can propose one
> +paragraph summary that appears in the "What's cooking" report when it
> +is picked up to explain the topic.  If you choose to do so, please
> +write 2-5 lines of a paragraph that will fit well in our release notes

Maybe "please write a 2-5 line paragraph"?

> +(see Documentation/RelNotes/* directory for examples), and make it
> +the first paragraph of the cover letter.  For a single-patch series,
> +use the space between the three-dash line and the diffstat, as
> +described earlier.

I think this is a good idea - one question though, how do you want patch authors to indicate that the first paragraph should be used as the summary?

Best Wishes

Phillip