linux-kernel - Re: [PATCH] rculist.h: docu: fix wrong function summary

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] [day] [month] [year] [list]

Date:   Wed, 20 Sep 2023 03:56:03 -0700
From:   "Paul E. McKenney" <paulmck@...nel.org>
To:     Philipp Stanner <pstanner@...hat.com>
Cc:     Frederic Weisbecker <frederic@...nel.org>,
        Neeraj Upadhyay <quic_neeraju@...cinc.com>,
        Joel Fernandes <joel@...lfernandes.org>,
        Josh Triplett <josh@...htriplett.org>,
        Boqun Feng <boqun.feng@...il.com>,
        Steven Rostedt <rostedt@...dmis.org>,
        Mathieu Desnoyers <mathieu.desnoyers@...icios.com>,
        Lai Jiangshan <jiangshanlai@...il.com>,
        Zqiang <qiang.zhang1211@...il.com>, rcu@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] rculist.h: docu: fix wrong function summary

On Wed, Sep 20, 2023 at 11:22:12AM +0200, Philipp Stanner wrote:
> The brief summary in the docstring for function list_next_or_null_rcu()
> states that the function is supposed to provide the "first" member of a
> list, whereas in truth it returns the next member.
> 
> Change the docstring so it describes what the function actually does.
> 
> Signed-off-by: Philipp Stanner <pstanner@...hat.com>

Queued and pushed, thank you!

							Thanx, Paul

> ---
>  include/linux/rculist.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/rculist.h b/include/linux/rculist.h
> index 4837d8892691..fd0ed1550a7c 100644
> --- a/include/linux/rculist.h
> +++ b/include/linux/rculist.h
> @@ -355,7 +355,7 @@ static inline void list_splice_tail_init_rcu(struct list_head *list,
>  })
>  
>  /**
> - * list_next_or_null_rcu - get the first element from a list
> + * list_next_or_null_rcu - get the next element from a list
>   * @head:	the head for the list.
>   * @ptr:        the list head to take the next element from.
>   * @type:       the type of the struct this is embedded in.
> -- 
> 2.41.0
>