[PATCH v1 1/1] bitmap: Align documentation between bitmap_gather() and bitmap_scatter()

[PATCH v1 1/1] bitmap: Align documentation between bitmap_gather() and bitmap_scatter()

[Andy Shevchenko]

First of all, 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: de5f84338970 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 include/linux/bitmap.h | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/include/linux/bitmap.h b/include/linux/bitmap.h
index 2026953e2c4e..595217b7a6e7 100644
--- a/include/linux/bitmap.h
+++ b/include/linux/bitmap.h
@@ -560,9 +560,9 @@ void bitmap_replace(unsigned long *dst,
  *	      ...0..11...0..10
  *	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.
- * See bitmap_scatter() for details related to this relationship.
  */
 static __always_inline
 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
  *
  * 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).
  * The operation bitmap_gather(result, scattered, mask, n) leads to a result
  * equal or equivalent to src.
-- 
2.43.0.rc1.1336.g36b5255a03ac

Re: [PATCH v1 1/1] bitmap: Align documentation between bitmap_gather() and bitmap_scatter()

[Yury Norov]

Hi Andy,

On Mon, Feb 03, 2025 at 02:19:19PM +0200, Andy Shevchenko wrote:
> First of all, the bitmap_scatter() mistakenly refers to itself for

It seems there's no 2nd concern. So I removed the 'First of all' part
and applied in bitmap-for-next.

Thanks,
Yury

> detailed explanation about the relationships of two. Instead of simply
> fixing this, align text in both making a cross-reference.
> 
> Fixes: de5f84338970 ("lib/bitmap: Introduce bitmap_scatter() and bitmap_gather() helpers")
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
>  include/linux/bitmap.h | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)
> 
> diff --git a/include/linux/bitmap.h b/include/linux/bitmap.h
> index 2026953e2c4e..595217b7a6e7 100644
> --- a/include/linux/bitmap.h
> +++ b/include/linux/bitmap.h
> @@ -560,9 +560,9 @@ void bitmap_replace(unsigned long *dst,
>   *	      ...0..11...0..10
>   *	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.
> - * See bitmap_scatter() for details related to this relationship.
>   */
>  static __always_inline
>  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
>   *
>   * 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).
>   * The operation bitmap_gather(result, scattered, mask, n) leads to a result
>   * equal or equivalent to src.
> -- 
> 2.43.0.rc1.1336.g36b5255a03ac

Re: [PATCH v1 1/1] bitmap: Align documentation between bitmap_gather() and bitmap_scatter()

[Andy Shevchenko]

On Mon, Feb 03, 2025 at 12:01:37PM -0500, Yury Norov wrote:
> Hi Andy,
> 
> On Mon, Feb 03, 2025 at 02:19:19PM +0200, Andy Shevchenko wrote:
> > First of all, the bitmap_scatter() mistakenly refers to itself for
> 
> It seems there's no 2nd concern. So I removed the 'First of all' part
> and applied in bitmap-for-next.

Thank you!

-- 
With Best Regards,
Andy Shevchenko