Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <ad80d41e-3e82-3188-f1e5-631e631a1fe4@gmail.com>
Date:   Thu, 5 May 2022 09:30:08 +0900
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.8.1
From:   Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH net-next] net/core: Remove comment quote for
 __dev_queue_xmit()
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>
References: <9d8b436a-5d8d-2a53-a2a1-5fbab987e41b@gmail.com>
 <c578c9e6-b2a5-3294-d291-2abfda7d1aed@gmail.com>
 <20220504073707.5bd851b0@kernel.org>
Content-Language: en-US
In-Reply-To: <20220504073707.5bd851b0@kernel.org>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

[+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.  
>