| Message ID | 20240314120006.458580-1-herve.codina@bootlin.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 2d9d9f256c8c85049306df3131ec7c81f9d8317c |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | [v2] lib/bitmap: Fix bitmap_scatter() and bitmap_gather() kernel doc | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Not a local patch |
On Thu, Mar 14, 2024 at 01:00:06PM +0100, Herve Codina wrote: > 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. Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
On Thu, Mar 14, 2024 at 01:00:06PM +0100, Herve Codina wrote: > diff --git a/include/linux/bitmap.h b/include/linux/bitmap.h > index fb3a9c93ac86..aa4096126553 100644 > --- a/include/linux/bitmap.h > +++ b/include/linux/bitmap.h > @@ -522,17 +522,18 @@ static inline void bitmap_replace(unsigned long *dst, > * > * (Bits 0, 1, 2, 3, 4, 5 are copied to the bits 0, 1, 4, 8, 9, 12) > * > - * A more 'visual' description of the operation: > - * src: 0000000001011010 > - * |||||| > - * +------+||||| > - * | +----+|||| > - * | |+----+||| > - * | || +-+|| > - * | || | || > - * mask: ...v..vv...v..vv > - * ...0..11...0..10 > - * dst: 0000001100000010 > + * A more 'visual' description of the operation:: > + * > + * src: 0000000001011010 > + * |||||| > + * +------+||||| > + * | +----+|||| > + * | |+----+||| > + * | || +-+|| > + * | || | || > + * mask: ...v..vv...v..vv > + * ...0..11...0..10 > + * dst: 0000001100000010 > * > * A relationship exists between bitmap_scatter() and bitmap_gather(). > * bitmap_gather() can be seen as the 'reverse' bitmap_scatter() operation. > @@ -568,16 +569,17 @@ static inline void bitmap_scatter(unsigned long *dst, const unsigned long *src, > * > * (Bits 0, 1, 4, 8, 9, 12 are copied to the bits 0, 1, 2, 3, 4, 5) > * > - * A more 'visual' description of the operation: > - * mask: ...v..vv...v..vv > - * src: 0000001100000010 > - * ^ ^^ ^ 0 > - * | || | 10 > - * | || > 010 > - * | |+--> 1010 > - * | +--> 11010 > - * +----> 011010 > - * dst: 0000000000011010 > + * A more 'visual' description of the operation:: > + * > + * mask: ...v..vv...v..vv > + * src: 0000001100000010 > + * ^ ^^ ^ 0 > + * | || | 10 > + * | || > 010 > + * | |+--> 1010 > + * | +--> 11010 > + * +----> 011010 > + * dst: 0000000000011010 > * > * A relationship exists between bitmap_gather() and bitmap_scatter(). See > * bitmap_scatter() for the bitmap scatter detailed operations. LGTM, thanks! Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
On Thu, 14 Mar 2024 13:00:06 +0100 Herve Codina wrote: > 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. > > Fixes: de5f84338970 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers") > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Closes: https://lore.kernel.org/linux-kernel/20240312153059.3ffde1b7@canb.auug.org.au/ > Signed-off-by: Herve Codina <herve.codina@bootlin.com> We took the offending commit via netdev, so I feel responsible. Please LMK if anyone else is planning to apply this fix, otherwise we'll take it and ship it to Linus on Thursday (19th).
On Tue, Mar 19, 2024 at 07:33:38PM -0700, Jakub Kicinski wrote: > On Thu, 14 Mar 2024 13:00:06 +0100 Herve Codina wrote: > > 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. > > > > Fixes: de5f84338970 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers") > > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > > Closes: https://lore.kernel.org/linux-kernel/20240312153059.3ffde1b7@canb.auug.org.au/ > > Signed-off-by: Herve Codina <herve.codina@bootlin.com> > > We took the offending commit via netdev, so I feel responsible. Please > LMK if anyone else is planning to apply this fix, otherwise we'll take > it and ship it to Linus on Thursday (19th). Please go ahead and add my Acked-by: Yury Norov <yury.norov@gmail.com>
On Wed, 20 Mar 2024 11:34:40 -0700 Yury Norov wrote: > > We took the offending commit via netdev, so I feel responsible. Please > > LMK if anyone else is planning to apply this fix, otherwise we'll take > > it and ship it to Linus on Thursday (19th). > > Please go ahead and add my > > Acked-by: Yury Norov <yury.norov@gmail.com> Done, thank you!
Hello: This patch was applied to netdev/net.git (main) by Jakub Kicinski <kuba@kernel.org>: On Thu, 14 Mar 2024 13:00:06 +0100 you wrote: > 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. > > Fixes: de5f84338970 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers") > Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> > Closes: https://lore.kernel.org/linux-kernel/20240312153059.3ffde1b7@canb.auug.org.au/ > Signed-off-by: Herve Codina <herve.codina@bootlin.com> > > [...] Here is the summary with links: - [v2] lib/bitmap: Fix bitmap_scatter() and bitmap_gather() kernel doc https://git.kernel.org/netdev/net/c/2d9d9f256c8c You are awesome, thank you!
diff --git a/include/linux/bitmap.h b/include/linux/bitmap.h index fb3a9c93ac86..aa4096126553 100644 --- a/include/linux/bitmap.h +++ b/include/linux/bitmap.h @@ -522,17 +522,18 @@ static inline void bitmap_replace(unsigned long *dst, * * (Bits 0, 1, 2, 3, 4, 5 are copied to the bits 0, 1, 4, 8, 9, 12) * - * A more 'visual' description of the operation: - * src: 0000000001011010 - * |||||| - * +------+||||| - * | +----+|||| - * | |+----+||| - * | || +-+|| - * | || | || - * mask: ...v..vv...v..vv - * ...0..11...0..10 - * dst: 0000001100000010 + * A more 'visual' description of the operation:: + * + * src: 0000000001011010 + * |||||| + * +------+||||| + * | +----+|||| + * | |+----+||| + * | || +-+|| + * | || | || + * mask: ...v..vv...v..vv + * ...0..11...0..10 + * dst: 0000001100000010 * * A relationship exists between bitmap_scatter() and bitmap_gather(). * bitmap_gather() can be seen as the 'reverse' bitmap_scatter() operation. @@ -568,16 +569,17 @@ static inline void bitmap_scatter(unsigned long *dst, const unsigned long *src, * * (Bits 0, 1, 4, 8, 9, 12 are copied to the bits 0, 1, 2, 3, 4, 5) * - * A more 'visual' description of the operation: - * mask: ...v..vv...v..vv - * src: 0000001100000010 - * ^ ^^ ^ 0 - * | || | 10 - * | || > 010 - * | |+--> 1010 - * | +--> 11010 - * +----> 011010 - * dst: 0000000000011010 + * A more 'visual' description of the operation:: + * + * mask: ...v..vv...v..vv + * src: 0000001100000010 + * ^ ^^ ^ 0 + * | || | 10 + * | || > 010 + * | |+--> 1010 + * | +--> 11010 + * +----> 011010 + * dst: 0000000000011010 * * A relationship exists between bitmap_gather() and bitmap_scatter(). See * bitmap_scatter() for the bitmap scatter detailed operations.
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. Fixes: de5f84338970 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers") Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Closes: https://lore.kernel.org/linux-kernel/20240312153059.3ffde1b7@canb.auug.org.au/ Signed-off-by: Herve Codina <herve.codina@bootlin.com> --- Changes v1 -> v2 Add Fixes, Reported-by and Closes tags include/linux/bitmap.h | 44 ++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 21 deletions(-)