linux-kernel - Re: [PATCH] include/linux/find: Fix documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <YlRNwV3jlikHfu/v@smile.fi.intel.com>
Date:   Mon, 11 Apr 2022 18:48:17 +0300
From:   Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
To:     Anna-Maria Behnsen <anna-maria@...utronix.de>
Cc:     linux-kernel@...r.kernel.org, Thomas Gleixner <tglx@...utronix.de>,
        Yury Norov <yury.norov@...il.com>,
        Rasmus Villemoes <linux@...musvillemoes.dk>
Subject: Re: [PATCH] include/linux/find: Fix documentation

On Mon, Apr 11, 2022 at 05:05:55PM +0200, Anna-Maria Behnsen wrote:
> The order of the arguments in function documentation doesn't fit the
> implementation. Change the documentation so that it corresponds to the
> code. This prevent people to get confused when reading the documentation.

Reviewed-by: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>

> Signed-off-by: Anna-Maria Behnsen <anna-maria@...utronix.de>
> ---
>  include/linux/find.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/linux/find.h b/include/linux/find.h
> index 5bb6db213bcb..424ef67d4a42 100644
> --- a/include/linux/find.h
> +++ b/include/linux/find.h
> @@ -21,8 +21,8 @@ extern unsigned long _find_last_bit(const unsigned long *addr, unsigned long siz
>  /**
>   * find_next_bit - find the next set bit in a memory region
>   * @addr: The address to base the search on
> - * @offset: The bitnumber to start searching at
>   * @size: The bitmap size in bits
> + * @offset: The bitnumber to start searching at
>   *
>   * Returns the bit number for the next set bit
>   * If no bits are set, returns @size.
> @@ -50,8 +50,8 @@ unsigned long find_next_bit(const unsigned long *addr, unsigned long size,
>   * find_next_and_bit - find the next set bit in both memory regions
>   * @addr1: The first address to base the search on
>   * @addr2: The second address to base the search on
> - * @offset: The bitnumber to start searching at
>   * @size: The bitmap size in bits
> + * @offset: The bitnumber to start searching at
>   *
>   * Returns the bit number for the next set bit
>   * If no bits are set, returns @size.
> @@ -79,8 +79,8 @@ unsigned long find_next_and_bit(const unsigned long *addr1,
>  /**
>   * find_next_zero_bit - find the next cleared bit in a memory region
>   * @addr: The address to base the search on
> - * @offset: The bitnumber to start searching at
>   * @size: The bitmap size in bits
> + * @offset: The bitnumber to start searching at
>   *
>   * Returns the bit number of the next zero bit
>   * If no bits are zero, returns @size.
> -- 
> 2.20.1
> 

-- 
With Best Regards,
Andy Shevchenko