linux-kernel - [PATCH] Documentation: add Internal-reference-ID: patch tag

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-next>] [day] [month] [year] [list]

Message-Id: <20110729180028.6a2091b3.rdunlap@xenotime.net>
Date:	Fri, 29 Jul 2011 18:00:28 -0700
From:	Randy Dunlap <rdunlap@...otime.net>
To:	lkml <linux-kernel@...r.kernel.org>
Cc:	Mike Waychison <mikew@...gle.com>,
	Greg Kroah-Hartman <gregkh@...e.de>,
	Andrew Morton <akpm@...ux-foundation.org>,
	"H. Peter Anvin" <hpa@...or.com>, Theodore Tso <tytso@....EDU>,
	Alan Cox <alan@...rguk.ukuu.org.uk>
Subject: [PATCH] Documentation: add Internal-reference-ID: patch tag

From: Randy Dunlap <rdunlap@...otime.net>

Introduce "Internal-reference-ID:" for company-internal
patch tracking.  Also clarify that URLs in patches should be
public, not private.

Based on emails from Greg Kroah-Hartman.

Internal-reference-ID: rdunlap.2011.0729.id1

Signed-off-by: Randy Dunlap <rdunlap@...otime.net>
Cc: Mike Waychison <mikew@...gle.com>
Cc: Greg Kroah-Hartman <gregkh@...e.de>
Cc: Andrew Morton <akpm@...ux-foundation.org>
Cc: "H. Peter Anvin" <hpa@...or.com>
Cc: Theodore Tso <tytso@....EDU>
Cc: Alan Cox <alan@...rguk.ukuu.org.uk>
---
 Documentation/SubmittingPatches |   25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

--- linux-3.0-git11.orig/Documentation/SubmittingPatches
+++ linux-3.0-git11/Documentation/SubmittingPatches
@@ -108,7 +108,14 @@ This benefits both the patch merger(s) a
 probably didn't even receive earlier versions of the patch.
 
 If the patch fixes a logged bug entry, refer to that bug entry by
-number and URL.
+number and URL (for URLs that are public, i.e., available to
+everyone).
+
+Please don't include private (internal) URLs in patch descriptions,
+so just say something like:
+	Fixes fubar.com bugzilla #4311
+instead of
+	Fixes bugzilla.fubar.com/show_bug.cgi?id=4311
 
 
 3) Separate your changes.
@@ -469,7 +476,19 @@ understand the subject area and to perfo
 increase the likelihood of your patch getting into the kernel.
 
 
-15) The canonical patch format
+15) Internal-reference-ID: tag
+
+Sometimes a company wants to include an internal reference ID (tag)
+in a patch so that they can have better patch tracking.  Instead of
+having a bazillion different such ID tags, the accepted one for
+everyone to use is:
+
+Internal-reference-ID: <text>
+
+<text> should not be a private (internal) URL.
+
+
+16) The canonical patch format
 
 The canonical patch subject line is:
 
@@ -583,7 +602,7 @@ See more details on the proper patch for
 references.
 
 
-16) Sending "git pull" requests  (from Linus emails)
+17) Sending "git pull" requests  (from Linus emails)
 
 Please write the git repo address and branch name alone on the same line
 so that I can't even by mistake pull from the wrong branch, and so
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/