| Message ID | 20240710-kd-crush_choose_indep-v1-2-fe2b85f322c6@quicinc.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | libceph: fix kernel-doc warnings | expand |
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>
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
diff --git a/net/ceph/crush/mapper.c b/net/ceph/crush/mapper.c index 3194d5090963..16a0f7e63d37 100644 --- a/net/ceph/crush/mapper.c +++ b/net/ceph/crush/mapper.c @@ -429,7 +429,10 @@ static int is_out(const struct crush_map *map, /** * crush_choose_firstn - choose numrep distinct items of given type * @map: the crush_map + * @work: crush workspace initialized by crush_init_workspace() * @bucket: the bucket we are choose an item from + * @weight: weight vector (for map leaves) + * @weight_max: size of weight vector * @x: crush input value * @numrep: the number of items to choose * @type: the type of item to choose @@ -445,6 +448,7 @@ static int is_out(const struct crush_map *map, * @vary_r: pass r to recursive calls * @out2: second output vector for leaf items (if @recurse_to_leaf) * @parent_r: r value passed from the parent + * @choose_args: weights and ids for each known bucket */ static int crush_choose_firstn(const struct crush_map *map, struct crush_work *work,
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> --- net/ceph/crush/mapper.c | 4 ++++ 1 file changed, 4 insertions(+)