Commit 359bc01d authored by Jeff Johnson's avatar Jeff Johnson Committed by Ilya Dryomov

libceph: fix crush_choose_firstn() kernel-doc warnings

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: default avatarJeff Johnson <quic_jjohnson@quicinc.com>
Reviewed-by: default avatarSimon Horman <horms@kernel.org>
Signed-off-by: default avatarIlya Dryomov <idryomov@gmail.com>
parent 6463c360
...@@ -429,7 +429,10 @@ static int is_out(const struct crush_map *map, ...@@ -429,7 +429,10 @@ static int is_out(const struct crush_map *map,
/** /**
* crush_choose_firstn - choose numrep distinct items of given type * crush_choose_firstn - choose numrep distinct items of given type
* @map: the crush_map * @map: the crush_map
* @work: working space initialized by crush_init_workspace()
* @bucket: the bucket we are choose an item from * @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 * @x: crush input value
* @numrep: the number of items to choose * @numrep: the number of items to choose
* @type: the type of item to choose * @type: the type of item to choose
...@@ -445,6 +448,7 @@ static int is_out(const struct crush_map *map, ...@@ -445,6 +448,7 @@ static int is_out(const struct crush_map *map,
* @vary_r: pass r to recursive calls * @vary_r: pass r to recursive calls
* @out2: second output vector for leaf items (if @recurse_to_leaf) * @out2: second output vector for leaf items (if @recurse_to_leaf)
* @parent_r: r value passed from the parent * @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, static int crush_choose_firstn(const struct crush_map *map,
struct crush_work *work, struct crush_work *work,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment