From: Dragan Simic <dsimic@manjaro.org>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, "Brian Lyles" <brianmlyles@gmail.com>,
phillip.wood123@gmail.com, "Jean-Noël AVILA" <jn.avila@free.fr>
Subject: Re: [PATCH v2] SubmittingPatches: release-notes entry experiment
Date: Tue, 26 Mar 2024 08:43:08 +0100 [thread overview]
Message-ID: <506be88207b63ed25067c374d3da8c09@manjaro.org> (raw)
In-Reply-To: <xmqq8r26eyva.fsf@gitster.g>
On 2024-03-25 23:21, Junio C Hamano wrote:
> The "What's cooking" report lists the topics in flight, with a short
> paragraph descibing what they are about.
>
> Once written, the description is automatically picked up from the
> "What's cooking" report and used in the commit log message of the
> merge commit when the topic is merged into integration branches.
> These commit log messges of the merge commits are then propagated to
> the release notes.
>
> It has been the maintainer's task to prepare these entries in the
> "What's cooking" report. Even though the original author of a topic
> may be in the best position to write the initial description of a
> topic, we so far lacked a formal channel for the author to suggest
> what description to use. The usual procedure has been for the
> author to see the topic described in "What's cooking" report, and
> then either complain about inaccurate explanation and/or offer a
> rewrite.
>
> Let's try an experiment to optionally let the author propose the one
> paragraph description when the topic is submitted. Pick the cover
> letter as the logical place to do so, and describe an experimental
> workflow in the SubmittingPatches document.
>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Looking good to me.
Reviewed-by: Dragan Simic <dsimic@manjaro.org>
> ---
> * An experimental procedure for a topic author to propose the topic
> description to be used in "What's cooking" report and in the
> release notes have been added to the SubmittingPatches document.
>
> The above is an example that follows this protocol for a
> single-patch series.
>
> >> Would it be beneficial to request some specific heading, phrase,
> or
> >> other structured text such that this summary is obvious, or even
> easily
> >> extracted with some sort of script? Or is that perhaps overkill
> for now?
> >
> > ... the rule might end up
> > to be as simple as "When the first paragraph of the message looks
> > like an entry in the Release Notes, it is used as such".
>
> Range-diff:
> 1: 83f8b69ab9 ! 1: 86b861255b SubmittingPatches: release-notes entry
> experiment
> ## Documentation/SubmittingPatches ##
> @@ Documentation/SubmittingPatches: an explanation of changes
> between each iteration can be kept in
> @@ Documentation/SubmittingPatches: an explanation of changes
> between each iteratio
> +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
> -+(see Documentation/RelNotes/* directory for examples), and put it
> in
> -+the cover letter, clearly marked as such. For a single-patch
> series,
> ++(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.
> +
>
> Documentation/SubmittingPatches | 11 +++++++++++
> 1 file changed, 11 insertions(+)
>
> 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
> +(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.
> +
> [[attachment]]
> Do not attach the patch as a MIME attachment, compressed or not.
> Do not let your e-mail client send quoted-printable. Do not let
next prev parent reply other threads:[~2024-03-26 7:43 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 [this message]
2024-03-26 14:18 ` Phillip Wood
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=506be88207b63ed25067c374d3da8c09@manjaro.org \
--to=dsimic@manjaro.org \
--cc=brianmlyles@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jn.avila@free.fr \
--cc=phillip.wood123@gmail.com \
/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).