linux-kernel - Re: [PATCH] android: fix W=1 kernel-doc warnings

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]

Message-ID: <Y8MchYSzhQil3Kc+@google.com>
Date:   Sat, 14 Jan 2023 21:20:05 +0000
From:   Carlos Llamas <cmllamas@...gle.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Arve Hjønnevåg <arve@...roid.com>,
        Todd Kjos <tkjos@...roid.com>,
        Martijn Coenen <maco@...roid.com>,
        Joel Fernandes <joel@...lfernandes.org>,
        Christian Brauner <christian@...uner.io>,
        Suren Baghdasaryan <surenb@...gle.com>
Subject: Re: [PATCH] android: fix W=1 kernel-doc warnings

On Thu, Jan 12, 2023 at 10:36:17PM -0800, Randy Dunlap wrote:
> Clean up kernel-doc notation, use correct function and parameter
> names.
> 
> drivers/android/binderfs.c:236: warning: expecting prototype for binderfs_ctl_ioctl(). Prototype was for binder_ctl_ioctl() instead
> drivers/android/binder.c:386: warning: expecting prototype for binder_node_unlock(). Prototype was for binder_node_inner_unlock() instead
> drivers/android/binder.c:1206: warning: expecting prototype for binder_dec_ref(). Prototype was for binder_dec_ref_olocked() instead
> drivers/andrond/binder.c:284: warning: Excess function parameter 'proc' description in 'binder_proc_unlock'
> drivers/andrond/binder.c:387: warning: expecting prototype for binder_node_unlock(). Prototype was for binder_node_inner_unlock() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Arve Hjønnevåg <arve@...roid.com>
> Cc: Todd Kjos <tkjos@...roid.com>
> Cc: Martijn Coenen <maco@...roid.com>
> Cc: Joel Fernandes <joel@...lfernandes.org>
> Cc: Christian Brauner <christian@...uner.io>
> Cc: Carlos Llamas <cmllamas@...gle.com>
> Cc: Suren Baghdasaryan <surenb@...gle.com>
> ---
>  drivers/android/binder.c   |   16 ++++++++--------
>  drivers/android/binderfs.c |    4 ++--
>  2 files changed, 10 insertions(+), 10 deletions(-)
> 
> diff -- a/drivers/android/binder.c b/drivers/android/binder.c
> --- a/drivers/android/binder.c
> +++ b/drivers/android/binder.c
> @@ -277,7 +277,7 @@ _binder_proc_lock(struct binder_proc *pr
>  
>  /**
>   * binder_proc_unlock() - Release spinlock for given binder_proc
> - * @proc:         struct binder_proc to acquire
> + * @_proc:                struct binder_proc to acquire

I think we could rename the parameter to "proc" instead. This aligns
with the other macros defined here. Aside from this minor nit:

Acked-by: Carlos Llamas <cmllamas@...gle.com>

Thanks Randy.