Skip to content

Commit d255105

Browse files
committed
SubmittingPatches: release-notes entry experiment
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 <[email protected]>
1 parent 11c821f commit d255105

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

Documentation/SubmittingPatches

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -459,6 +459,18 @@ an explanation of changes between each iteration can be kept in
459459
Git-notes and inserted automatically following the three-dash
460460
line via `git format-patch --notes`.
461461

462+
[[the-topic-summary]]
463+
*This is EXPERIMENTAL*.
464+
465+
When sending a topic, you can propose a one-paragraph summary that
466+
should appear in the "What's cooking" report when it is picked up to
467+
explain the topic. If you choose to do so, please write a 2-5 line
468+
paragraph that will fit well in our release notes (see many bulleted
469+
entries in the Documentation/RelNotes/* files for examples), and make
470+
it the first paragraph of the cover letter. For a single-patch
471+
series, use the space between the three-dash line and the diffstat, as
472+
described earlier.
473+
462474
[[attachment]]
463475
Do not attach the patch as a MIME attachment, compressed or not.
464476
Do not let your e-mail client send quoted-printable. Do not let

0 commit comments

Comments
 (0)