Skip to content

Commit 4fa5c37

Browse files
rddunlapaxboe
authored andcommitted
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>
1 parent 8337b02 commit 4fa5c37

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

block/blk-cgroup.h

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,9 @@ void blkg_conf_exit(struct blkg_conf_ctx *ctx);
225225

226226
/**
227227
* 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.
229231
*
230232
* In order to avoid priority inversions we sometimes need to issue a bio as if
231233
* it were attached to the root blkg, and then backcharge to the actual owning
@@ -245,7 +247,7 @@ static inline bool bio_issue_as_root_blkg(struct bio *bio)
245247
* @q: request_queue of interest
246248
*
247249
* Lookup blkg for the @blkcg - @q pair.
248-
250+
*
249251
* Must be called in a RCU critical section.
250252
*/
251253
static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg,
@@ -268,7 +270,7 @@ static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg,
268270
}
269271

270272
/**
271-
* blkg_to_pdata - get policy private data
273+
* blkg_to_pd - get policy private data
272274
* @blkg: blkg of interest
273275
* @pol: policy of interest
274276
*
@@ -287,7 +289,7 @@ static inline struct blkcg_policy_data *blkcg_to_cpd(struct blkcg *blkcg,
287289
}
288290

289291
/**
290-
* pdata_to_blkg - get blkg associated with policy private data
292+
* pd_to_blkg - get blkg associated with policy private data
291293
* @pd: policy private data of interest
292294
*
293295
* @pd is policy private data. Determine the blkg it's associated with.

0 commit comments

Comments
 (0)