Re: [PATCH v2] SubmittingPatches: release-notes entry experiment

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Junio

On 25/03/2024 22:21, Junio C Hamano wrote:
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

Maybe "please write a 2-5 line paragraph"?

+(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.

I think this is a good idea - one question though, how do you want patch authors to indicate that the first paragraph should be used as the summary?

Best Wishes

Phillip




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux