Skip to content

Commit ab44704

Browse files
committed
Merge branch 'tb/doc-submitting-patches'
A few more things that patch authors can do to help maintainer to keep track of their topics better. * tb/doc-submitting-patches: SubmittingPatches: guidance for multi-series efforts SubmittingPatches: extend release-notes experiment to topic names
2 parents cd6c082 + 1a41698 commit ab44704

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
@@ -579,14 +579,27 @@ line via `git format-patch --notes`.
579579
[[the-topic-summary]]
580580
*This is EXPERIMENTAL*.
581581

582-
When sending a topic, you can propose a one-paragraph summary that
583-
should appear in the "What's cooking" report when it is picked up to
584-
explain the topic. If you choose to do so, please write a 2-5 line
585-
paragraph that will fit well in our release notes (see many bulleted
586-
entries in the Documentation/RelNotes/* files for examples), and make
587-
it the first paragraph of the cover letter. For a single-patch
588-
series, use the space between the three-dash line and the diffstat, as
589-
described earlier.
582+
When sending a topic, you can optionally propose a topic name and/or a
583+
one-paragraph summary that should appear in the "What's cooking"
584+
report when it is picked up to explain the topic. If you choose to do
585+
so, please write a 2-5 line paragraph that will fit well in our
586+
release notes (see many bulleted entries in the
587+
Documentation/RelNotes/* files for examples), and make it the first
588+
(or second, if including a suggested topic name) paragraph of the
589+
cover letter. If suggesting a topic name, use the format
590+
"XX/your-topic-name", where "XX" is a stand-in for the primary
591+
author's initials, and "your-topic-name" is a brief, dash-delimited
592+
description of what your topic does. For a single-patch series, use
593+
the space between the three-dash line and the diffstat, as described
594+
earlier.
595+
596+
[[multi-series-efforts]]
597+
If your patch series is part of a larger effort spanning multiple
598+
patch series, briefly describe the broader goal, and state where the
599+
current series fits into that goal. If you are suggesting a topic
600+
name as in <<the-topic-summary, section above>>, consider
601+
"XX/the-broader-goal-part-one", "XX/the-broader-goal-part-two", and so
602+
on.
590603

591604
[[attachment]]
592605
Do not attach the patch as a MIME attachment, compressed or not.

0 commit comments

Comments
 (0)