From: Phillip Wood <phillip.wood123@gmail.com>
To: Junio C Hamano <gitster@pobox.com>, git@vger.kernel.org
Cc: "Brian Lyles" <brianmlyles@gmail.com>,
"Jean-Noël AVILA" <jn.avila@free.fr>
Subject: Re: [PATCH v2] SubmittingPatches: release-notes entry experiment
Date: Tue, 26 Mar 2024 14:18:10 +0000 [thread overview]
Message-ID: <dda1ba52-7b43-4017-96e7-10080618d4e7@gmail.com> (raw)
In-Reply-To: <xmqq8r26eyva.fsf@gitster.g>
Hi Junio
On 25/03/2024 22:21, Junio C Hamano wrote:
> 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
next prev parent reply other threads:[~2024-03-26 14:18 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-25 22:21 [PATCH v2] SubmittingPatches: release-notes entry experiment Junio C Hamano
2024-03-25 23:37 ` Brian Lyles
2024-03-26 7:32 ` Junio C Hamano
2024-03-26 7:51 ` Dragan Simic
2024-03-26 7:43 ` Dragan Simic
2024-03-26 14:18 ` Phillip Wood [this message]
2024-03-26 16:28 ` Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=dda1ba52-7b43-4017-96e7-10080618d4e7@gmail.com \
--to=phillip.wood123@gmail.com \
--cc=brianmlyles@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jn.avila@free.fr \
--cc=phillip.wood@dunelm.org.uk \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).