Commit 2d9d9f25 authored by Herve Codina's avatar Herve Codina Committed by Jakub Kicinski

lib/bitmap: Fix bitmap_scatter() and bitmap_gather() kernel doc

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: de5f8433 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-kernel/20240312153059.3ffde1b7@canb.auug.org.au/Signed-off-by: default avatarHerve Codina <herve.codina@bootlin.com>
Reviewed-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Acked-by: default avatarYury Norov <yury.norov@gmail.com>
Link: https://lore.kernel.org/r/20240314120006.458580-1-herve.codina@bootlin.comSigned-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 9c6a5954
...@@ -522,17 +522,18 @@ static inline void bitmap_replace(unsigned long *dst, ...@@ -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) * (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: * A more 'visual' description of the operation::
* src: 0000000001011010 *
* |||||| * src: 0000000001011010
* +------+||||| * ||||||
* | +----+|||| * +------+|||||
* | |+----+||| * | +----+||||
* | || +-+|| * | |+----+|||
* | || | || * | || +-+||
* mask: ...v..vv...v..vv * | || | ||
* ...0..11...0..10 * mask: ...v..vv...v..vv
* dst: 0000001100000010 * ...0..11...0..10
* dst: 0000001100000010
* *
* A relationship exists between bitmap_scatter() and bitmap_gather(). * A relationship exists between bitmap_scatter() and bitmap_gather().
* bitmap_gather() can be seen as the 'reverse' bitmap_scatter() operation. * 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, ...@@ -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) * (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: * A more 'visual' description of the operation::
* mask: ...v..vv...v..vv *
* src: 0000001100000010 * mask: ...v..vv...v..vv
* ^ ^^ ^ 0 * src: 0000001100000010
* | || | 10 * ^ ^^ ^ 0
* | || > 010 * | || | 10
* | |+--> 1010 * | || > 010
* | +--> 11010 * | |+--> 1010
* +----> 011010 * | +--> 11010
* dst: 0000000000011010 * +----> 011010
* dst: 0000000000011010
* *
* A relationship exists between bitmap_gather() and bitmap_scatter(). See * A relationship exists between bitmap_gather() and bitmap_scatter(). See
* bitmap_scatter() for the bitmap scatter detailed operations. * bitmap_scatter() for the bitmap scatter detailed operations.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment