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

[Randy Dunlap]

On Mon, 15 Aug 2011 14:36:41 -0400 Arnaud Lacombe wrote:

> Hi,
> 
> On Fri, Jul 29, 2011 at 9:00 PM, Randy Dunlap <rdunlap@xxxxxxxxxxxx> wrote:
> > From: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
> >
> > 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
> >
> What's the point of this for individuals ? Couldn't the Message-id
> from the mail be re-used ?
> 
>  - Arnaud

Individuals or companies might like to track their upstream patches
easily.  A pseudo-random message-id doesn't do that (for me).


> > Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
> > Cc: Mike Waychison <mikew@xxxxxxxxxx>
> > Cc: Greg Kroah-Hartman <gregkh@xxxxxxx>
> > Cc: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
> > Cc: "H. Peter Anvin" <hpa@xxxxxxxxx>
> > Cc: Theodore Tso <tytso@xxxxxxx>
> > Cc: Alan Cox <alan@xxxxxxxxxxxxxxxxxxx>
> > ---
> >  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
> > --


---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/