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

From: Kees Cook
Date: Fri Jun 21 2024 - 17:07:56 EST


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:

$ git log --grep Link: | grep 'Link:.*\[' > links.txt
$ wc -l links.txt
1687 links.txt

# Link: URL... [1]
$ grep 'Link: .*[^#] \[' links.txt | wc -l
1546

# Link: URL... # [1]
$ grep 'Link: .* # \[' links.txt | wc -l
83

# Link: [1] URL...
$ grep 'Link: \[' links.txt | wc -l
44

# Link: URL... [#1]
$ grep 'Link: .*\[#' links.txt | wc -l
12


--
Kees Cook