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

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

Correct the function parameters and function names to eliminate
kernel-doc warnings:

blk-cgroup.h:238: warning: Function parameter or struct member 'bio' not described in 'bio_issue_as_root_blkg'
blk-cgroup.h:248: warning: bad line:
blk-cgroup.h:279: warning: expecting prototype for blkg_to_pdata(). Prototype was for blkg_to_pd() instead
blk-cgroup.h:296: warning: expecting prototype for pdata_to_blkg(). Prototype was for pd_to_blkg() instead

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/20250111062736.910383-1-rdunlap@infradead.org
Signed-off-by: Jens Axboe <axboe@kernel.dk>

authored by

Randy Dunlap and committed by
Jens Axboe
4fa5c370 8337b029

+6 -4
+6 -4
block/blk-cgroup.h
··· 225 225 226 226 /** 227 227 * bio_issue_as_root_blkg - see if this bio needs to be issued as root blkg 228 - * @return: true if this bio needs to be submitted with the root blkg context. 228 + * @bio: the target &bio 229 + * 230 + * Return: true if this bio needs to be submitted with the root blkg context. 229 231 * 230 232 * In order to avoid priority inversions we sometimes need to issue a bio as if 231 233 * it were attached to the root blkg, and then backcharge to the actual owning ··· 247 245 * @q: request_queue of interest 248 246 * 249 247 * Lookup blkg for the @blkcg - @q pair. 250 - 248 + * 251 249 * Must be called in a RCU critical section. 252 250 */ 253 251 static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, ··· 270 268 } 271 269 272 270 /** 273 - * blkg_to_pdata - get policy private data 271 + * blkg_to_pd - get policy private data 274 272 * @blkg: blkg of interest 275 273 * @pol: policy of interest 276 274 * ··· 289 287 } 290 288 291 289 /** 292 - * pdata_to_blkg - get blkg associated with policy private data 290 + * pd_to_blkg - get blkg associated with policy private data 293 291 * @pd: policy private data of interest 294 292 * 295 293 * @pd is policy private data. Determine the blkg it's associated with.