From: Randy Dunlap <[email protected]>
Add <linux/bitmap.h> to kernel-api Bitmap Operations section.
Fix kernel-doc nitpicks in <linux/bitmap.h>.
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Yury Norov <[email protected]>
---
Documentation/core-api/kernel-api.rst | 3 +++
include/linux/bitmap.h | 9 +++++----
2 files changed, 8 insertions(+), 4 deletions(-)
--- lnx-414-rc1.orig/Documentation/core-api/kernel-api.rst
+++ lnx-414-rc1/Documentation/core-api/kernel-api.rst
@@ -59,6 +59,9 @@ Bitmap Operations
.. kernel-doc:: lib/bitmap.c
:internal:
+.. kernel-doc:: include/linux/bitmap.h
+ :internal:
+
Command-line Parsing
--------------------
--- lnx-414-rc1.orig/include/linux/bitmap.h
+++ lnx-414-rc1/include/linux/bitmap.h
@@ -360,8 +360,9 @@ static inline int bitmap_parse(const cha
return __bitmap_parse(buf, buflen, 0, maskp, nmaskbits);
}
-/*
+/**
* BITMAP_FROM_U64() - Represent u64 value in the format suitable for bitmap.
+ * @n: u64 value
*
* Linux bitmaps are internally arrays of unsigned longs, i.e. 32-bit
* integers in 32-bit environment, and 64-bit integers in 64-bit one.
@@ -392,14 +393,14 @@ static inline int bitmap_parse(const cha
((unsigned long) ((u64)(n) >> 32))
#endif
-/*
+/**
* bitmap_from_u64 - Check and swap words within u64.
* @mask: source bitmap
* @dst: destination bitmap
*
- * In 32-bit Big Endian kernel, when using (u32 *)(&val)[*]
+ * In 32-bit Big Endian kernel, when using ``(u32 *)(&val)[*]``
* to read u64 mask, we will get the wrong word.
- * That is "(u32 *)(&val)[0]" gets the upper 32 bits,
+ * That is ``(u32 *)(&val)[0]`` gets the upper 32 bits,
* but we expect the lower 32-bits of u64.
*/
static inline void bitmap_from_u64(unsigned long *dst, u64 mask)
On Sun, Sep 17, 2017 at 07:07:10PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <[email protected]>
>
> Add <linux/bitmap.h> to kernel-api Bitmap Operations section.
> Fix kernel-doc nitpicks in <linux/bitmap.h>.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Yury Norov <[email protected]>
Acked-by: Yury Norov <[email protected]>
> ---
> Documentation/core-api/kernel-api.rst | 3 +++
> include/linux/bitmap.h | 9 +++++----
> 2 files changed, 8 insertions(+), 4 deletions(-)
>
> --- lnx-414-rc1.orig/Documentation/core-api/kernel-api.rst
> +++ lnx-414-rc1/Documentation/core-api/kernel-api.rst
> @@ -59,6 +59,9 @@ Bitmap Operations
> .. kernel-doc:: lib/bitmap.c
> :internal:
>
> +.. kernel-doc:: include/linux/bitmap.h
> + :internal:
> +
> Command-line Parsing
> --------------------
>
> --- lnx-414-rc1.orig/include/linux/bitmap.h
> +++ lnx-414-rc1/include/linux/bitmap.h
> @@ -360,8 +360,9 @@ static inline int bitmap_parse(const cha
> return __bitmap_parse(buf, buflen, 0, maskp, nmaskbits);
> }
>
> -/*
> +/**
> * BITMAP_FROM_U64() - Represent u64 value in the format suitable for bitmap.
> + * @n: u64 value
> *
> * Linux bitmaps are internally arrays of unsigned longs, i.e. 32-bit
> * integers in 32-bit environment, and 64-bit integers in 64-bit one.
> @@ -392,14 +393,14 @@ static inline int bitmap_parse(const cha
> ((unsigned long) ((u64)(n) >> 32))
> #endif
>
> -/*
> +/**
> * bitmap_from_u64 - Check and swap words within u64.
> * @mask: source bitmap
> * @dst: destination bitmap
> *
> - * In 32-bit Big Endian kernel, when using (u32 *)(&val)[*]
> + * In 32-bit Big Endian kernel, when using ``(u32 *)(&val)[*]``
> * to read u64 mask, we will get the wrong word.
> - * That is "(u32 *)(&val)[0]" gets the upper 32 bits,
> + * That is ``(u32 *)(&val)[0]`` gets the upper 32 bits,
> * but we expect the lower 32-bits of u64.
> */
> static inline void bitmap_from_u64(unsigned long *dst, u64 mask)
>
On Sun, 17 Sep 2017 19:07:10 -0700
Randy Dunlap <[email protected]> wrote:
> Add <linux/bitmap.h> to kernel-api Bitmap Operations section.
> Fix kernel-doc nitpicks in <linux/bitmap.h>.
Applied, thanks.
jon