[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20240628143224.6fb67dfd@rorschach.local.home>
Date: Fri, 28 Jun 2024 14:32:24 -0400
From: Steven Rostedt <rostedt@...dmis.org>
To: Konstantin Ryabitsev <konstantin@...uxfoundation.org>
Cc: Thorsten Leemhuis <linux@...mhuis.info>, Randy Dunlap
<rdunlap@...radead.org>, Jonathan Corbet <corbet@....net>, Kees Cook
<kees@...nel.org>, Carlos Bilbao <carlos.bilbao.osdev@...il.com>, "David S.
Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, Jakub
Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
workflows@...r.kernel.org, linux-doc@...r.kernel.org,
linux-kernel@...r.kernel.org, netdev@...r.kernel.org,
ksummit@...ts.linux.dev
Subject: Re: [PATCH v2 2/2] Documentation: best practices for using Link
trailers
On Fri, 28 Jun 2024 10:52:37 -0400
Konstantin Ryabitsev <konstantin@...uxfoundation.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@...pany.com>
[ Fixed formatting ]
Signed-off-by: Steven Rostedt (Google) <rostedt@...dmis.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
Powered by blists - more mailing lists