Thread (18 messages) 18 messages, 9 authors, 2024-07-03

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

From: Steven Rostedt <rostedt@goodmis.org>
Date: 2024-06-28 18:32:28
Also in: linux-doc, lkml, workflows

On Fri, 28 Jun 2024 10:52:37 -0400
Konstantin Ryabitsev [off-list ref] wrote:
On Thu, Jun 27, 2024 at 05:51:47AM GMT, Thorsten Leemhuis wrote:
quoted
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.  
This is inconsistent with every other trailer that includes comments.
Currently, there are two mechanisms to provide comments with trailers:

1:

    | Trailer-name: trailer-content # trailer-comment

2:

    | Trailer-name: trailer-content
    | [trailer-comment]
Where do you see that?

Whenever I do the second one, it has nothing to do with the tag, but
what I have done to the patch/commit.

    Signed-off-by: Random Developer [off-list ref]
    [ Fixed formatting ]
    Signed-off-by: Steven Rostedt (Google) [off-list ref]

That is, if I do any modification of the original submission, I
document it this way.

-- Steve

For the sake of consistency, all trailers, including Link, should use one of
these two mechanisms for "optional-other-stuff".

-K
  
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help