Re: [PATCH v2 2/2] Documentation: best practices for using Link trailers

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




On 6/26/24 8:51 PM, Thorsten Leemhuis wrote:
> On 27.06.24 01:17, Randy Dunlap wrote:
>> On 6/26/24 4:13 PM, Jonathan Corbet wrote:
>>> Konstantin Ryabitsev <konstantin@xxxxxxxxxxxxxxxxxxx> writes:
>>>> On Fri, Jun 21, 2024 at 02:07:44PM GMT, Kees Cook wrote:
>>>>> On Wed, Jun 19, 2024 at 02:24:07PM -0400, Konstantin Ryabitsev wrote:
>>>>>> +   This URL should be used when referring to relevant mailing list
>>>>>> +   topics, related patch sets, or other notable discussion threads.
>>>>>> +   A convenient way to associate ``Link:`` trailers with the commit
>>>>>> +   message is to use markdown-like bracketed notation, for example::
>>>>>> ...
>>>>>> +     Link: https://lore.kernel.org/some-msgid@here # [1]
>>>>>> +     Link: https://bugzilla.example.org/bug/12345  # [2]
>>>>>
>>>>> Why are we adding the extra "# " characters? The vast majority of
>>>>> existing Link tags don't do this:
>>>>
>>>> That's just convention. In general, the hash separates the trailer from the
>>>> comment:
>>>>
>>>>     Trailer-name: actual-trailer-body # comment
>>>
>>> Did we ever come to a conclusion on this?  This one character seems to
>>> be the main source of disagreement in this series, I'm wondering if I
>>> should just apply it and let the painting continue thereafter...?
>>
>> We have used '#' for ages for adding comments to by: tags.
>> I'm surprised that it's not documented.
> 
> I thought it was documented, but either I was wrong or can't find it.
> But I found process/5.Posting.rst, which provides this example:
> 
>         Link: https://example.com/somewhere.html  optional-other-stuff
> 
> So no "# " there. So to avoid inconsistencies I guess this should not be
> applied, unless that document is changed as well.

In my use cases, other-optional-stuff begins with '#'.


-- 
~Randy




[Index of Archives]     [Linux Samsung SoC]     [Linux Rockchip SoC]     [Linux Actions SoC]     [Linux for Synopsys ARC Processors]     [Linux NFS]     [Linux NILFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]


  Powered by Linux