lkml.org 
[lkml]   [2011]   [Jul]   [29]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subject[PATCH] Documentation: add Internal-reference-ID: patch tag
From: Randy Dunlap <rdunlap@xenotime.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@xenotime.net>
Cc: Mike Waychison <mikew@google.com>
Cc: Greg Kroah-Hartman <gregkh@suse.de>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Cc: Theodore Tso <tytso@MIT.EDU>
Cc: Alan Cox <alan@lxorguk.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

\
 
 \ /
  Last update: 2011-07-30 03:03    [from the cache]
©2003-2011 Jasper Spaans. Advertise on this site