From: Alejandro Colomar <alx@kernel.org>
Date: Wed, 6 Nov 2024 20:46:21 +0000 (+0100)
Subject: CONTRIBUTING.d/patches/subject: Add file documenting the subject of a patch
X-Git-Tag: man-pages-6.10~120
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=adbb547e660d7e59014b0956f541f58c514b4088;p=thirdparty%2Fman-pages.git

CONTRIBUTING.d/patches/subject: Add file documenting the subject of a patch

Signed-off-by: Alejandro Colomar <alx@kernel.org>
---

diff --git a/CONTRIBUTING.d/patches/patches b/CONTRIBUTING.d/patches/patches
index 5a45b9ca8..c1a9ebc48 100644
--- a/CONTRIBUTING.d/patches/patches
+++ b/CONTRIBUTING.d/patches/patches
@@ -11,10 +11,6 @@ Description
           from <CONTRIBUTING.d/mail>.  See also "Send the patches"
           below.
 
-       -  The subject of the email should contain "[PATCH]" in the
-          subject line.  This prefix might include more information,
-          such as the version of the patch: "[PATCH v1]".
-
        The above is the minimum needed so that someone might respond to
        your patch.  If you did that and someone does not respond within
        a few days, then ping the email thread, "replying to all".  Make
@@ -24,11 +20,6 @@ Description
        To make your patch even more useful, please note the following
        points:
 
-       -  Write a suitable subject line.  Make sure to mention the
-          name(s) of the page(s) being patched.  Example:
-
-             [PATCH v1] shmop.2: Add "(void *)" cast to RETURN VALUE
-
        -  Sign your patch with "Signed-off-by:".  Read about the
           "Developer's Certificate of Origin" at
           <https://www.kernel.org/doc/Documentation/process/submitting-patches.rst>.
@@ -72,18 +63,6 @@ Description
 
               .\" linux.git commit <40-character-git-hash>
 
-       -  For trivial patches, you can use subject tags:
-
-          -  ffix: Formatting fix.
-          -  tfix: Typo fix.
-          -  wfix: Minor wording fix.
-          -  srcfix: Change to manual page source that doesn't affect
-             the output.
-
-          Example:
-
-              [PATCH v1] tcp.7: tfix
-
        -  Send logically separate patches.  For unrelated pages, or for
           logically-separate issues in the same page, send separate
           emails.
diff --git a/CONTRIBUTING.d/patches/subject b/CONTRIBUTING.d/patches/subject
new file mode 100644
index 000000000..208bb9ef8
--- /dev/null
+++ b/CONTRIBUTING.d/patches/subject
@@ -0,0 +1,41 @@
+Name
+	patches/subject - instructions for writing the subject of a patch
+
+Description
+	The subject is the first line of the patch description (i.e.,
+	the commit message).
+
+    File names
+	Mention the name(s) of the file(s) being patched.
+
+	When the files are manual pages, you should write only the
+	basename(1).  Otherwise, write the full path.  When several
+	files in a directory are modified, write the name of the
+	directory, with a trailing '/'.  Example:
+
+		[PATCH v1] shmop.2: Add "(void *)" cast to RETURN VALUE
+
+    English sentence
+	The subject line after the file-name prefix should be a correct
+	English sentence.  The only exception is that we omit the
+	trailing period.  The sentence should start in upper case,
+	unless it starts with a term that must go in lower case.
+
+    Trivial subject
+	For trivial patches, you can use subject tags:
+
+		ffix	Formatting fix.
+		tfix	Typo fix.
+		wfix	Minor wording fix.
+		srcfix	Change to manual page source that doesn't affect
+			the output.
+
+	Example:
+
+		[PATCH v1] tcp.7: tfix
+
+    [PATCH] prefix
+	When sending the patch via email, the prefix "[PATCH]" should be
+	prepended to the patch subject to form the "Subject:" header
+	field of the email.  This prefix might include more information,
+	such as the version of the patch: "[PATCH v1]".