mbox series

[net-next,0/2] libceph: fix kernel-doc warnings

Message ID 20240710-kd-crush_choose_indep-v1-0-fe2b85f322c6@quicinc.com
Headers show
Series libceph: fix kernel-doc warnings | expand

Message

Jeff Johnson July 10, 2024, 6:10 p.m. UTC 
I split this into two patches due to the nature of the two fixes.
Let me know if you prefer them to be squashed.

---
Jeff Johnson (2):
      libceph: suppress crush_choose_indep() kernel-doc warnings
      libceph: fix crush_choose_firstn() kernel-doc warnings

 net/ceph/crush/mapper.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
---
base-commit: 523b23f0bee3014a7a752c9bb9f5c54f0eddae88
change-id: 20240710-kd-crush_choose_indep-02a9f906efe4

Comments

Simon Horman July 11, 2024, 1:34 p.m. UTC | #1 
On Wed, Jul 10, 2024 at 11:10:04AM -0700, Jeff Johnson wrote:
> Currently, when built with "make W=1", the following warnings are
> generated:
> 
> net/ceph/crush/mapper.c:466: warning: Function parameter or struct member 'work' not described in 'crush_choose_firstn'
> net/ceph/crush/mapper.c:466: warning: Function parameter or struct member 'weight' not described in 'crush_choose_firstn'
> net/ceph/crush/mapper.c:466: warning: Function parameter or struct member 'weight_max' not described in 'crush_choose_firstn'
> net/ceph/crush/mapper.c:466: warning: Function parameter or struct member 'choose_args' not described in 'crush_choose_firstn'
> 
> Update the crush_choose_firstn() kernel-doc to document these
> parameters.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>

Reviewed-by: Simon Horman <horms@kernel.org>
Ilya Dryomov July 11, 2024, 2:36 p.m. UTC | #2 
On Thu, Jul 11, 2024 at 3:34 PM Simon Horman <horms@kernel.org> wrote:
>
> On Wed, Jul 10, 2024 at 11:10:04AM -0700, Jeff Johnson wrote:
> > Currently, when built with "make W=1", the following warnings are
> > generated:
> >
> > net/ceph/crush/mapper.c:466: warning: Function parameter or struct member 'work' not described in 'crush_choose_firstn'
> > net/ceph/crush/mapper.c:466: warning: Function parameter or struct member 'weight' not described in 'crush_choose_firstn'
> > net/ceph/crush/mapper.c:466: warning: Function parameter or struct member 'weight_max' not described in 'crush_choose_firstn'
> > net/ceph/crush/mapper.c:466: warning: Function parameter or struct member 'choose_args' not described in 'crush_choose_firstn'
> >
> > Update the crush_choose_firstn() kernel-doc to document these
> > parameters.
> >
> > Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
>
> Reviewed-by: Simon Horman <horms@kernel.org>

Applied with a small tweak.

Thanks,

                Ilya