git
/
linux
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

bitmap: Align documentation between bitmap_gather() and bitmap_scatter() 

The bitmap_scatter() mistakenly refers to itself for detailed explanation
about the relationships of two. Instead of simply fixing this, align text
in both making a cross-reference.

Fixes: de5f843389 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Yury Norov <yury.norov@gmail.com>
This commit is contained in:
Andy Shevchenko 2025-02-03 14:19:19 +02:00 committed by Yury Norov
parent 2408a807bf
commit f54af4af7b
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
include/linux/bitmap.h
View File

@ -560,9 +560,9 @@ void bitmap_replace(unsigned long *dst,
* ...0..11...0..10 * ...0..11...0..10
* dst: 0000001100000010 * dst: 0000001100000010
* *
* A relationship exists between bitmap_scatter() and bitmap_gather(). * A relationship exists between bitmap_scatter() and bitmap_gather(). See
* bitmap_gather() for the bitmap gather detailed operations. TL;DR:
* bitmap_gather() can be seen as the 'reverse' bitmap_scatter() operation. * bitmap_gather() can be seen as the 'reverse' bitmap_scatter() operation.
* See bitmap_scatter() for details related to this relationship.
*/ */
static __always_inline static __always_inline
void bitmap_scatter(unsigned long *dst, const unsigned long *src, void bitmap_scatter(unsigned long *dst, const unsigned long *src,
@ -608,7 +608,9 @@ void bitmap_scatter(unsigned long *dst, const unsigned long *src,
* dst: 0000000000011010 * 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. TL;DR:
* bitmap_scatter() can be seen as the 'reverse' bitmap_gather() operation.
*
* Suppose scattered computed using bitmap_scatter(scattered, src, mask, n). * Suppose scattered computed using bitmap_scatter(scattered, src, mask, n).
* The operation bitmap_gather(result, scattered, mask, n) leads to a result * The operation bitmap_gather(result, scattered, mask, n) leads to a result
* equal or equivalent to src. * equal or equivalent to src.