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

Unified · Split

include/linux/bitmap.h+23−21
@@ -522,17 +522,18 @@ static inline void bitmap_replace(unsigned long *dst, · 521 unmodified lines
522522 *
523523 * (Bits 0, 1, 2, 3, 4, 5 are copied to the bits 0, 1, 4, 8, 9, 12)
524524 *
525− * A more 'visual' description of the operation:
526− * src: 0000000001011010
527− * ||||||
528− * +------+|||||
529− * | +----+||||
530− * | |+----+|||
531− * | || +-+||
532− * | || | ||
533− * mask: ...v..vv...v..vv
534− * ...0..11...0..10
535− * dst: 0000001100000010
525+ * A more 'visual' description of the operation::
526+ *
527+ * src: 0000000001011010
528+ * ||||||
529+ * +------+|||||
530+ * | +----+||||
531+ * | |+----+|||
532+ * | || +-+||
533+ * | || | ||
534+ * mask: ...v..vv...v..vv
535+ * ...0..11...0..10
536+ * dst: 0000001100000010
536537 *
537538 * A relationship exists between bitmap_scatter() and bitmap_gather().
538539 * 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
568569 *
569570 * (Bits 0, 1, 4, 8, 9, 12 are copied to the bits 0, 1, 2, 3, 4, 5)
570571 *
571− * A more 'visual' description of the operation:
572− * mask: ...v..vv...v..vv
573− * src: 0000001100000010
574− * ^ ^^ ^ 0
575− * | || | 10
576− * | || > 010
577− * | |+--> 1010
578− * | +--> 11010
579− * +----> 011010
580− * dst: 0000000000011010
572+ * A more 'visual' description of the operation::
573+ *
574+ * mask: ...v..vv...v..vv
575+ * src: 0000001100000010
576+ * ^ ^^ ^ 0
577+ * | || | 10
578+ * | || > 010
579+ * | |+--> 1010
580+ * | +--> 11010
581+ * +----> 011010
582+ * dst: 0000000000011010
581583 *
582584 * A relationship exists between bitmap_gather() and bitmap_scatter(). See
583585 * 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