From: Josh Triplett <josh@joshtriplett.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Andrew Morton <akpm@linux-foundation.org>,
Borislav Petkov <bp@suse.de>, Rob Landley <rob@landley.net>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH RESEND 2/3] SubmittingPatches: Add recommendation for mailing list references
Date: Sat, 22 Feb 2014 14:30:38 -0800 [thread overview]
Message-ID: <20140222223038.GA4643@thin> (raw)
In-Reply-To: <53091D26.4020900@infradead.org>
On Sat, Feb 22, 2014 at 01:56:54PM -0800, Randy Dunlap wrote:
> On 02/22/2014 12:12 PM, Josh Triplett wrote:
> > SubmittingPatches already mentions referencing bugs fixed by a commit,
> > but doesn't mention citing relevant mailing list discussions. Add a
> > note to that effect, along with a recommendation to use the
> > https://lkml.kernel.org/ redirector.
> >
> > Portions based on text from git's SubmittingPatches.
> >
> > Signed-off-by: Josh Triplett <josh@joshtriplett.org>
> > Acked-by: Borislav Petkov <bp@suse.de>
> > ---
> > Documentation/SubmittingPatches | 10 +++++++++-
> > 1 file changed, 9 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> > index c74e73c..53e6590 100644
> > --- a/Documentation/SubmittingPatches
> > +++ b/Documentation/SubmittingPatches
> > @@ -112,7 +112,15 @@ to do frotz", as if you are giving orders to the codebase to change
> > its behaviour.
> >
> > If the patch fixes a logged bug entry, refer to that bug entry by
> > -number and URL.
> > +number and URL. If the patch follows from a mailing list discussion,
> > +give a URL to the mailing list archive; use the https://lkml.kernel.org/
> > +redirector with a Message-Id, to ensure that the links cannot become
> > +stale.
>
> Some of us don't know what that looks like.
> Could we have an example?
https://lkml.kernel.org/ provides examples; I didn't want to duplicate
that documentation.
- Josh Triplett
next prev parent reply other threads:[~2014-02-22 22:30 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-02-22 20:12 [PATCH RESEND 1/3] SubmittingPatches: Add style recommendation to use imperative descriptions Josh Triplett
2014-02-22 20:12 ` [PATCH RESEND 2/3] SubmittingPatches: Add recommendation for mailing list references Josh Triplett
2014-02-22 21:56 ` Randy Dunlap
2014-02-22 22:30 ` Josh Triplett [this message]
2014-02-22 22:39 ` Borislav Petkov
2014-02-22 23:04 ` Randy Dunlap
2014-02-22 20:12 ` [PATCH RESEND 3/3] SubmittingPatches: Document the use of git Josh Triplett
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20140222223038.GA4643@thin \
--to=josh@joshtriplett.org \
--cc=akpm@linux-foundation.org \
--cc=bp@suse.de \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=rob@landley.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox