Re: [PATCH RESEND 2/3] SubmittingPatches: Add recommendation for mailing list references

[Randy Dunlap <rdunlap@infradead.org>]

On 02/22/2014 02:30 PM, Josh Triplett wrote:
> 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.

Thanks, I didn't know that and wouldn't normally look there to see if
it provides examples, so you could do like Boris suggested... :)


-- 
~Randy