Skip to content

Commit 0f65b08

Browse files
committed
Merge branch 'tb/doc-submitting-patches' into seen
* tb/doc-submitting-patches: SubmittingPatches: guidance for multi-series efforts SubmittingPatches: extend release-notes experiment to topic names
2 parents c849c07 + 1a41698 commit 0f65b08

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

Documentation/SubmittingPatches

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -607,14 +607,27 @@ line via `git format-patch --notes`.
607607
[[the-topic-summary]]
608608
*This is EXPERIMENTAL*.
609609

610-
When sending a topic, you can propose a one-paragraph summary that
611-
should appear in the "What's cooking" report when it is picked up to
612-
explain the topic. If you choose to do so, please write a 2-5 line
613-
paragraph that will fit well in our release notes (see many bulleted
614-
entries in the Documentation/RelNotes/* files for examples), and make
615-
it the first paragraph of the cover letter. For a single-patch
616-
series, use the space between the three-dash line and the diffstat, as
617-
described earlier.
610+
When sending a topic, you can optionally propose a topic name and/or a
611+
one-paragraph summary that should appear in the "What's cooking"
612+
report when it is picked up to explain the topic. If you choose to do
613+
so, please write a 2-5 line paragraph that will fit well in our
614+
release notes (see many bulleted entries in the
615+
Documentation/RelNotes/* files for examples), and make it the first
616+
(or second, if including a suggested topic name) paragraph of the
617+
cover letter. If suggesting a topic name, use the format
618+
"XX/your-topic-name", where "XX" is a stand-in for the primary
619+
author's initials, and "your-topic-name" is a brief, dash-delimited
620+
description of what your topic does. For a single-patch series, use
621+
the space between the three-dash line and the diffstat, as described
622+
earlier.
623+
624+
[[multi-series-efforts]]
625+
If your patch series is part of a larger effort spanning multiple
626+
patch series, briefly describe the broader goal, and state where the
627+
current series fits into that goal. If you are suggesting a topic
628+
name as in <<the-topic-summary, section above>>, consider
629+
"XX/the-broader-goal-part-one", "XX/the-broader-goal-part-two", and so
630+
on.
618631

619632
[[attachment]]
620633
Do not attach the patch as a MIME attachment, compressed or not.

0 commit comments

Comments
 (0)