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

blk-cgroup: rwstat: fix kernel-doc warnings in header file

Correct the function parameters to eliminate kernel-doc warnings:

blk-cgroup-rwstat.h:63: warning: Function parameter or struct member 'opf' not described in 'blkg_rwstat_add'
blk-cgroup-rwstat.h:63: warning: Excess function parameter 'op' description in 'blkg_rwstat_add'
blk-cgroup-rwstat.h:91: warning: Function parameter or struct member 'result' not described in 'blkg_rwstat_read'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Tejun Heo <tj@kernel.org>
Cc: Josef Bacik <josef@toxicpanda.com>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: cgroups@vger.kernel.org
Link: https://lore.kernel.org/r/20250111062748.910442-1-rdunlap@infradead.org
Signed-off-by: Jens Axboe <axboe@kernel.dk>

authored by

Randy Dunlap and committed by
Jens Axboe
f403034e 4fa5c370

+3 -2
+3 -2
block/blk-cgroup-rwstat.h
··· 52 52 /** 53 53 * blkg_rwstat_add - add a value to a blkg_rwstat 54 54 * @rwstat: target blkg_rwstat 55 - * @op: REQ_OP and flags 55 + * @opf: REQ_OP and flags 56 56 * @val: value to add 57 57 * 58 58 * Add @val to @rwstat. The counters are chosen according to @rw. The ··· 83 83 /** 84 84 * blkg_rwstat_read - read the current values of a blkg_rwstat 85 85 * @rwstat: blkg_rwstat to read 86 + * @result: where to put the current values 86 87 * 87 - * Read the current snapshot of @rwstat and return it in the aux counts. 88 + * Read the current snapshot of @rwstat and return it in the @result counts. 88 89 */ 89 90 static inline void blkg_rwstat_read(struct blkg_rwstat *rwstat, 90 91 struct blkg_rwstat_sample *result)