Re: [PATCH] lib/bitmap: Fix bitmap_scatter() and bitmap_gather() kernel doc

From
Florian Fainelli <f.fainelli@gmail.com>
Date
2024-03-12 16:39:26
Also in
lkml
Reply to
Herve Codina, 2024-03-12
On 3/12/24 09:35, Herve Codina wrote:
Hi Andy,

On Tue, 12 Mar 2024 17:43:00 +0200
Andy Shevchenko [off-list ref] wrote:
quoted
On Tue, Mar 12, 2024 at 05:42:11PM +0200, Andy Shevchenko wrote:
quoted
On Tue, Mar 12, 2024 at 09:54:03AM +0100, Herve Codina wrote:
quoted
The make htmldoc command failed with the following error
   ... include/linux/bitmap.h:524: ERROR: Unexpected indentation.
   ... include/linux/bitmap.h:524: CRITICAL: Unexpected section title or transition.

Move the visual representation to a literal block.
...
quoted
quoted
This patch fixes de5f84338970 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers")
available in net-next and linux-next
Not sure about rules of net-next, but I would add Fixes FWIW:

Fixes: de5f84338970 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers")
I think I cannot add the Fixes tag as the de5f84338970 commit is not yet
merged in Torvald's tree and I am not sure that the commit hash will not
change during the merge process.
That is not a reason for not providing a Fixes tag, it does not have to be in Linus' tree.

As a matter of fact, let us consider someone doing a back port of your patches into their custom local tree, they would like to have that information that this patch fixes a problem introduced by an earlier commit so they can take the entire set of commits as a whole.
-- 
Florian
Thread (6 messages) 6 messages, 3 authors, last reply 2024-03-12
Keyboard shortcuts
hback out one level
jnext message in thread / next series-diff position
kprevious message in thread / previous series-diff position
ldrill in
Escclose help / fold thread tree
?toggle this help