From: Akira Yokosawa <akiyks@gmail.com>
To: Jakub Kicinski <kuba@kernel.org>, Ben Greear <greearb@candelatech.com>
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
Pavel Begunkov <asml.silence@gmail.com>,
"David S. Miller" <davem@davemloft.net>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
netdev@vger.kernel.org, Stephen Rothwell <sfr@canb.auug.org.au>
Subject: Re: [PATCH net-next] net/core: Remove comment quote for __dev_queue_xmit()
Date: Thu, 5 May 2022 09:30:08 +0900 [thread overview]
Message-ID: <ad80d41e-3e82-3188-f1e5-631e631a1fe4@gmail.com> (raw)
In-Reply-To: <20220504073707.5bd851b0@kernel.org>
[+To: Ben]
[-Cc: unreachable addresses]
Hi,
On 2022/05/04 23:37,
Jakub Kicinski wrote:
> On Wed, 4 May 2022 22:43:12 +0900 Akira Yokosawa wrote:
>>> I can't think of preserving delineation between actual documentation
>>> and the quote without messing up kernel-doc.
>
> That's not what I'm complaining about, I'm saying that you rewrote
> the documentation. There were 3 paragraphs now there are 2.
>
>> Actually, it is possible.
>>
>> See "Block Quotes" in ReST documentation at:
>> https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#block-quotes
>>
>> kernel-doc is basically ReST within comment blocks with several kernel-doc
>> specific implicit/explicit markers.
>
> With all due respect I don't even know who (what?) "BLG" is.
In case this might help, this comment block was added in commit
af191367a752 ("[NET]: Document ->hard_start_xmit() locking in
comments.") authored by Ben way back in 2005.
Ben, if you want to see the circumstances, here is a link to the lore
archive.
https://lore.kernel.org/all/20220504073707.5bd851b0@kernel.org/#r
>
> Let's just get rid of the delineation and the signature and make
> the text of the quote normal documentation.
I'm not sure but Ben might be interested in helping rephrase the quote.
Thanks, Akira
>
>>> Actually the "--BLG" signature is the culprit.
>
prev parent reply other threads:[~2022-05-05 0:30 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-03 7:29 [PATCH net-next] net/core: Remove comment quote for __dev_queue_xmit() Bagas Sanjaya
2022-05-04 1:03 ` Jakub Kicinski
2022-05-04 4:28 ` Bagas Sanjaya
2022-05-04 13:43 ` Akira Yokosawa
2022-05-04 14:37 ` Jakub Kicinski
2022-05-05 0:30 ` Akira Yokosawa [this message]
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=ad80d41e-3e82-3188-f1e5-631e631a1fe4@gmail.com \
--to=akiyks@gmail.com \
--cc=asml.silence@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=davem@davemloft.net \
--cc=greearb@candelatech.com \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=sfr@canb.auug.org.au \
/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;
as well as URLs for NNTP newsgroup(s).