History

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.

Herve Codina committed 2 years ago

Commit 2d9d9f21 parent 9c6a5951 file · +23 −21Browse files

Showing the changes to include/linux/bitmap.h (1 of 1 file). Show all

Unified · Split

include/linux/bitmap.h+23−21
@@ -522,17 +522,18 @@ static inline void bitmap_replace(unsigned long *dst, · 521 unmodified lines
522 *522 *
523 * (Bits 0, 1, 2, 3, 4, 5 are copied to the bits 0, 1, 4, 8, 9, 12)523 * (Bits 0, 1, 2, 3, 4, 5 are copied to the bits 0, 1, 4, 8, 9, 12)
524 *524 *
525 * A more 'visual' description of the operation:525 * A more 'visual' description of the operation::
526 * src: 0000000001011010526 *
527 * ||||||527 * src: 0000000001011010
528 * +------+|||||528 * ||||||
529 * | +----+||||529 * +------+|||||
530 * | |+----+|||530 * | +----+||||
531 * | || +-+||531 * | |+----+|||
532 * | || | ||532 * | || +-+||
533 * mask: ...v..vv...v..vv533 * | || | ||
534 * ...0..11...0..10534 * mask: ...v..vv...v..vv
535 * dst: 0000001100000010535 * ...0..11...0..10
536 * dst: 0000001100000010
536 *537 *
537 * A relationship exists between bitmap_scatter() and bitmap_gather().538 * A relationship exists between bitmap_scatter() and bitmap_gather().
538 * bitmap_gather() can be seen as the 'reverse' bitmap_scatter() operation.539 * 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, · 29 unmodified lines
568 *569 *
569 * (Bits 0, 1, 4, 8, 9, 12 are copied to the bits 0, 1, 2, 3, 4, 5)570 * (Bits 0, 1, 4, 8, 9, 12 are copied to the bits 0, 1, 2, 3, 4, 5)
570 *571 *
571 * A more 'visual' description of the operation:572 * A more 'visual' description of the operation::
572 * mask: ...v..vv...v..vv573 *
573 * src: 0000001100000010574 * mask: ...v..vv...v..vv
574 * ^ ^^ ^ 0575 * src: 0000001100000010
575 * | || | 10576 * ^ ^^ ^ 0
576 * | || > 010577 * | || | 10
577 * | |+--> 1010578 * | || > 010
578 * | +--> 11010579 * | |+--> 1010
579 * +----> 011010580 * | +--> 11010
580 * dst: 0000000000011010581 * +----> 011010
582 * dst: 0000000000011010
581 *583 *
582 * A relationship exists between bitmap_gather() and bitmap_scatter(). See584 * A relationship exists between bitmap_gather() and bitmap_scatter(). See
583 * bitmap_scatter() for the bitmap scatter detailed operations.585 * bitmap_scatter() for the bitmap scatter detailed operations.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t