netdev - Re: [PATCH net-next 1/2] libceph: suppress crush_choose

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: <CAOi1vP9VRSq1TGZG+NmsDdtHx6rximzqqGT7waDHX2i4Fbyozw@mail.gmail.com>
Date: Thu, 11 Jul 2024 16:36:01 +0200
From: Ilya Dryomov <idryomov@...il.com>
To: Simon Horman <horms@...nel.org>
Cc: Jeff Johnson <quic_jjohnson@...cinc.com>, Xiubo Li <xiubli@...hat.com>, 
	"David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, 
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>, ceph-devel@...r.kernel.org, 
	netdev@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH net-next 1/2] libceph: suppress crush_choose_indep()
 kernel-doc warnings

On Thu, Jul 11, 2024 at 3:34 PM Simon Horman <horms@...nel.org> wrote:
>
> On Wed, Jul 10, 2024 at 11:10:03AM -0700, Jeff Johnson wrote:
> > Currently, when built with "make W=1", the following warnings are
> > generated:
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'map' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'work' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'bucket' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'weight' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'weight_max' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'x' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'left' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'numrep' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'type' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'out' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'outpos' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'tries' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'recurse_tries' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'recurse_to_leaf' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'out2' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'parent_r' not described in 'crush_choose_indep'
> > net/ceph/crush/mapper.c:655: warning: Function parameter or struct member 'choose_args' not described in 'crush_choose_indep'
> >
> > These warnings are generated because the prologue comment for
> > crush_choose_indep() uses the kernel-doc prefix, but the actual
> > comment is a very brief description that is not in kernel-doc
> > format. Since this is a static function there is no need to fully
> > document the function, so replace the kernel-doc comment prefix with a
> > standard comment prefix to remove these warnings.
> >
> > Signed-off-by: Jeff Johnson <quic_jjohnson@...cinc.com>
>
> Reviewed-by: Simon Horman <horms@...nel.org>

Applied with a small tweak.

Thanks,

                Ilya