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 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

-K




[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