From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753081Ab1G3BAc (ORCPT ); Fri, 29 Jul 2011 21:00:32 -0400 Received: from oproxy7-pub.bluehost.com ([67.222.55.9]:35726 "HELO oproxy7-pub.bluehost.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with SMTP id S1751285Ab1G3BAb (ORCPT ); Fri, 29 Jul 2011 21:00:31 -0400 Date: Fri, 29 Jul 2011 18:00:28 -0700 From: Randy Dunlap To: lkml Cc: Mike Waychison , Greg Kroah-Hartman , Andrew Morton , "H. Peter Anvin" , Theodore Tso , Alan Cox Subject: [PATCH] Documentation: add Internal-reference-ID: patch tag Message-Id: <20110729180028.6a2091b3.rdunlap@xenotime.net> Organization: YPO4 X-Mailer: Sylpheed 2.7.1 (GTK+ 2.16.6; x86_64-unknown-linux-gnu) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit X-Identified-User: {1807:box742.bluehost.com:xenotime:xenotime.net} {sentby:smtp auth 50.53.38.135 authed with rdunlap@xenotime.net} Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Randy Dunlap 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 Cc: Mike Waychison Cc: Greg Kroah-Hartman Cc: Andrew Morton Cc: "H. Peter Anvin" Cc: Theodore Tso Cc: Alan Cox --- 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: + + 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