workflows.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>,
	workflows@vger.kernel.org, linux-doc@vger.kernel.org
Cc: kernel-janitors@vger.kernel.org, linux-kernel@vger.kernel.org,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: [PATCH 1/3] docs: submitting-patches: divert focus from PATCH in the subject line
Date: Fri,  1 Mar 2024 14:46:35 +0100	[thread overview]
Message-ID: <20240301134637.27880-2-lukas.bulwahn@gmail.com> (raw)
In-Reply-To: <20240301134637.27880-1-lukas.bulwahn@gmail.com>

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@gmail.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


  reply	other threads:[~2024-03-01 13:46 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-01 13:46 [PATCH 0/3] Towards a re-organized submitting patches Lukas Bulwahn
2024-03-01 13:46 ` Lukas Bulwahn [this message]
2024-03-13 18:52   ` [PATCH 1/3] docs: submitting-patches: divert focus from PATCH in the subject line Randy Dunlap
2024-03-01 13:46 ` [PATCH 2/3] docs: submitting-patches: move split_changes before describe_change Lukas Bulwahn
2024-03-01 13:46 ` [PATCH 3/3] docs: submitting-patches: move backtraces to patch description Lukas Bulwahn
2024-03-03 16:31 ` [PATCH 0/3] Towards a re-organized submitting patches Jonathan Corbet
2024-03-05  7:54   ` Thorsten Leemhuis
2024-03-05 12:59     ` Jonathan Corbet
2024-03-05 13:23       ` Thorsten Leemhuis
2024-03-05 12:39   ` Lukas Bulwahn

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240301134637.27880-2-lukas.bulwahn@gmail.com \
    --to=lukas.bulwahn@gmail.com \
    --cc=corbet@lwn.net \
    --cc=kernel-janitors@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=workflows@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox