[PATCH v1 1/1] bitops: Update kernel-doc for sign_extendXX()

[PATCH v1 1/1] bitops: Update kernel-doc for sign_extendXX()

[Andy Shevchenko]

The sign_extendXX() lack of Return section and have other style
issues. Address that by updating kernel-doc accordingly.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 include/linux/bitops.h | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/include/linux/bitops.h b/include/linux/bitops.h
index 1fe46703792f..657eab2725ce 100644
--- a/include/linux/bitops.h
+++ b/include/linux/bitops.h
@@ -179,9 +179,11 @@ static inline __u8 ror8(__u8 word, unsigned int shift)
 /**
  * sign_extend32 - sign extend a 32-bit value using specified bit as sign-bit
  * @value: value to sign extend
- * @index: 0 based bit index (0<=index<32) to sign bit
+ * @index: 0 based bit index (0 <= index < 32) to sign bit
  *
  * This is safe to use for 16- and 8-bit types as well.
+ *
+ * Return: 32-bit sign extended value
  */
 static __always_inline __s32 sign_extend32(__u32 value, int index)
 {
@@ -192,7 +194,11 @@ static __always_inline __s32 sign_extend32(__u32 value, int index)
 /**
  * sign_extend64 - sign extend a 64-bit value using specified bit as sign-bit
  * @value: value to sign extend
- * @index: 0 based bit index (0<=index<64) to sign bit
+ * @index: 0 based bit index (0 <= index < 64) to sign bit
+ *
+ * This is safe to use for 32-, 16- and 8-bit types as well.
+ *
+ * Return: 64-bit sign extended value
  */
 static __always_inline __s64 sign_extend64(__u64 value, int index)
 {
-- 
2.50.1

Re: [PATCH v1 1/1] bitops: Update kernel-doc for sign_extendXX()

[Yury Norov]

On Tue, Apr 07, 2026 at 05:14:31PM +0200, Andy Shevchenko wrote:
> The sign_extendXX() lack of Return section and have other style
> issues. Address that by updating kernel-doc accordingly.
> 
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Applied, thanks.

> ---
>  include/linux/bitops.h | 10 ++++++++--
>  1 file changed, 8 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/bitops.h b/include/linux/bitops.h
> index 1fe46703792f..657eab2725ce 100644
> --- a/include/linux/bitops.h
> +++ b/include/linux/bitops.h
> @@ -179,9 +179,11 @@ static inline __u8 ror8(__u8 word, unsigned int shift)
>  /**
>   * sign_extend32 - sign extend a 32-bit value using specified bit as sign-bit
>   * @value: value to sign extend
> - * @index: 0 based bit index (0<=index<32) to sign bit
> + * @index: 0 based bit index (0 <= index < 32) to sign bit
>   *
>   * This is safe to use for 16- and 8-bit types as well.
> + *
> + * Return: 32-bit sign extended value
>   */
>  static __always_inline __s32 sign_extend32(__u32 value, int index)
>  {
> @@ -192,7 +194,11 @@ static __always_inline __s32 sign_extend32(__u32 value, int index)
>  /**
>   * sign_extend64 - sign extend a 64-bit value using specified bit as sign-bit
>   * @value: value to sign extend
> - * @index: 0 based bit index (0<=index<64) to sign bit
> + * @index: 0 based bit index (0 <= index < 64) to sign bit
> + *
> + * This is safe to use for 32-, 16- and 8-bit types as well.
> + *
> + * Return: 64-bit sign extended value
>   */
>  static __always_inline __s64 sign_extend64(__u64 value, int index)
>  {
> -- 
> 2.50.1