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

[Steven Rostedt <rostedt@goodmis.org>]

On Fri, 28 Jun 2024 10:52:37 -0400
Konstantin Ryabitsev <konstantin@linuxfoundation.org> wrote:

> On Thu, Jun 27, 2024 at 05:51:47AM GMT, Thorsten Leemhuis wrote:
> > 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 <rdevelop@company.com>
    [ Fixed formatting ]
    Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>

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