linux-kernel - [PATCH 1/3] docs: submitting-patches: divert focus from PATCH in the subject line

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Fri,  1 Mar 2024 14:46:35 +0100
From: Lukas Bulwahn <lukas.bulwahn@...il.com>
To: Jonathan Corbet <corbet@....net>,
	workflows@...r.kernel.org,
	linux-doc@...r.kernel.org
Cc: kernel-janitors@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: [PATCH 1/3] docs: submitting-patches: divert focus from PATCH in the subject line

Submitting-patches is already assuming that git is used to prepare
patches. So, developers will use git format-patch and git send-email, and
this will take care that PATCH is usually in the subject line. Hence, the
'include PATCH in the subject' does not deserve be an own section.

Move this note into 'the canonical patch format' section, where it
currently fits best.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@...il.com>
---
 Documentation/process/submitting-patches.rst | 14 ++++----------
 1 file changed, 4 insertions(+), 10 deletions(-)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 66029999b587..2ec0c0d7d68f 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -384,16 +384,6 @@ patch or patch series which have not been modified in any way from the
 previous submission.
 
 
-Include PATCH in the subject
------------------------------
-
-Due to high e-mail traffic to Linus, and to linux-kernel, it is common
-convention to prefix your subject line with [PATCH].  This lets Linus
-and other kernel developers more easily distinguish patches from other
-e-mail discussions.
-
-``git send-email`` will do this for you automatically.
-
 
 Sign your work - the Developer's Certificate of Origin
 ------------------------------------------------------
@@ -616,6 +606,10 @@ The canonical patch subject line is::
 
     Subject: [PATCH 001/123] subsystem: summary phrase
 
+Prefix your subject line with [PATCH]. This allows to distinguish patches
+from other e-mail discussions. ``git send-email`` will do this for you
+automatically.
+
 The canonical patch message body contains the following:
 
   - A ``from`` line specifying the patch author, followed by an empty
-- 
2.43.2