ksummit.lists.linux.dev archive mirror
 help / color / mirror / Atom feed
From: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
To: Thorsten Leemhuis <linux@leemhuis.info>
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Jonathan Corbet <corbet@lwn.net>,  Kees Cook <kees@kernel.org>,
	Carlos Bilbao <carlos.bilbao.osdev@gmail.com>,
	 "David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	 Jakub Kicinski <kuba@kernel.org>,
	Paolo Abeni <pabeni@redhat.com>,
	workflows@vger.kernel.org,  linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org, netdev@vger.kernel.org,
	 ksummit@lists.linux.dev
Subject: Re: [PATCH v2 2/2] Documentation: best practices for using Link trailers
Date: Fri, 28 Jun 2024 10:52:37 -0400	[thread overview]
Message-ID: <20240628-mindful-jackal-of-education-95059f@lemur> (raw)
In-Reply-To: <62647fab-b3d4-48ac-af4c-78c655dcff26@leemhuis.info>

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]

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

-K

  parent reply	other threads:[~2024-06-28 14:52 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-19 18:24 [PATCH v2 0/2] Documentation: update information for mailing lists Konstantin Ryabitsev
2024-06-19 18:24 ` [PATCH v2 2/2] Documentation: best practices for using Link trailers Konstantin Ryabitsev
2024-06-21 10:34   ` Michael S. Tsirkin
2024-06-21 21:07   ` Kees Cook
2024-06-21 21:37     ` Konstantin Ryabitsev
2024-06-26 23:13       ` Jonathan Corbet
2024-06-26 23:17         ` Randy Dunlap
2024-06-27  3:51           ` Thorsten Leemhuis
2024-06-27  4:24             ` Randy Dunlap
2024-06-28 14:52             ` Konstantin Ryabitsev [this message]
2024-06-28 18:32               ` Steven Rostedt
2024-06-22  4:27   ` Michael Ellerman
2024-06-22 14:40     ` Kees Cook
2024-06-22 15:15       ` Randy Dunlap
2024-06-22 20:13 ` [PATCH v2 0/2] Documentation: update information for mailing lists Carlos Bilbao
2024-07-02 20:47 ` Steven Rostedt
2024-07-03 23:04 ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240628-mindful-jackal-of-education-95059f@lemur \
    --to=konstantin@linuxfoundation.org \
    --cc=carlos.bilbao.osdev@gmail.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=kees@kernel.org \
    --cc=ksummit@lists.linux.dev \
    --cc=kuba@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@leemhuis.info \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=rdunlap@infradead.org \
    --cc=workflows@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox