Re: [PATCH net-next v2] net/core: use ReST block quote in __dev_queue_xmit() comment

From: Jakub Kicinski <kuba@kernel.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: linux-doc@vger.kernel.org,
	Stephen Rothwell <sfr@canb.auug.org.au>,
	Ben Greear <greearb@candelatech.com>,
	Pavel Begunkov <asml.silence@gmail.com>,
	"David S. Miller" <davem@davemloft.net>,
	Akira Yokosawa <akiyks@gmail.com>,
	netdev@vger.kernel.org, linux-next@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH net-next v2] net/core: use ReST block quote in __dev_queue_xmit() comment
Date: Thu, 5 May 2022 09:48:58 -0700	[thread overview]
Message-ID: <20220505094858.4a1fcbc6@kernel.org> (raw)
In-Reply-To: <20220505082907.42393-1-bagasdotme@gmail.com>

On Thu,  5 May 2022 15:29:07 +0700 Bagas Sanjaya wrote:
>   *	to congestion or traffic shaping.
>   *
>   * -----------------------------------------------------------------------------------
> - *      I notice this method can also return errors from the queue disciplines,
> - *      including NET_XMIT_DROP, which is a positive value.  So, errors can also
> - *      be positive.
>   *
> - *      Regardless of the return value, the skb is consumed, so it is currently
> - *      difficult to retry a send to this method.  (You can bump the ref count
> - *      before sending to hold a reference for retry if you are careful.)
> + *        I notice this method can also return errors from the queue disciplines,
> + *        including NET_XMIT_DROP, which is a positive value.  So, errors can also
> + *        be positive.
>   *
> - *      When calling this method, interrupts MUST be enabled.  This is because
> - *      the BH enable code must have IRQs enabled so that it will not deadlock.
> - *          --BLG
> + *        Regardless of the return value, the skb is consumed, so it is currently
> + *        difficult to retry a send to this method.  (You can bump the ref count
> + *        before sending to hold a reference for retry if you are careful.)
> + *
> + *        When calling this method, interrupts MUST be enabled.  This is because
> + *        the BH enable code must have IRQs enabled so that it will not deadlock.
> + *        --BLG

Rephrase the text as a normal function documentation and drop 
the banner and the signature, please.

The place to give people credit for providing the information 
is the git logs. So you can say something like:

  Rephrase the quote from Ben Greear (BLG) as a normal kdoc.

in the commit message.