Re: [PATCH net-next] net/core: Remove comment quote for __dev_queue_xmit()

[Akira Yokosawa]

[+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@xxxxxxxxxx/#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.  
>