Skip to content

Commit eda72dd

Browse files
committed
Merge branch 'jc/release-notes-entry-experiment'
Introduce an experimental protocol for contributors to propose the topic description to be used in the "What's cooking" report, the merge commit message for the topic, and in the release notes and document it in the SubmittingPatches document. * jc/release-notes-entry-experiment: SubmittingPatches: release-notes entry experiment
2 parents e139bb1 + d255105 commit eda72dd

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)