Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Jeff Johnson <quic_jjohnson@quicinc.com>
Reviewed-by: Simon Horman <horms@kernel.org>
Signed-off-by: Ilya Dryomov <idryomov@gmail.com>

authored by

Jeff Johnson and committed by
Ilya Dryomov
359bc01d 6463c360

+4
+4
net/ceph/crush/mapper.c
··· 429 429 /** 430 430 * crush_choose_firstn - choose numrep distinct items of given type 431 431 * @map: the crush_map 432 + * @work: working space initialized by crush_init_workspace() 432 433 * @bucket: the bucket we are choose an item from 434 + * @weight: weight vector (for map leaves) 435 + * @weight_max: size of weight vector 433 436 * @x: crush input value 434 437 * @numrep: the number of items to choose 435 438 * @type: the type of item to choose ··· 448 445 * @vary_r: pass r to recursive calls 449 446 * @out2: second output vector for leaf items (if @recurse_to_leaf) 450 447 * @parent_r: r value passed from the parent 448 + * @choose_args: weights and ids for each known bucket 451 449 */ 452 450 static int crush_choose_firstn(const struct crush_map *map, 453 451 struct crush_work *work,