Commit 4fa5c370 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jens Axboe
Browse files

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: default avatarRandy 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: default avatarJens Axboe <axboe@kernel.dk>
parent 8337b029

block/blk-cgroup.h

+6 −4
Original line number Diff line number Diff line
@@ -225,7 +225,9 @@ void blkg_conf_exit(struct blkg_conf_ctx *ctx); 


/**

 * bio_issue_as_root_blkg - see if this bio needs to be issued as root blkg

 * @return: true if this bio needs to be submitted with the root blkg context.

 * @bio: the target &bio

 *

 * Return: true if this bio needs to be submitted with the root blkg context.

 *

 * In order to avoid priority inversions we sometimes need to issue a bio as if

 * 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) 
 * @q: request_queue of interest

 *

 * Lookup blkg for the @blkcg - @q pair.



 *

 * Must be called in a RCU critical section.

 */

static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg,
@@ -268,7 +270,7 @@ static inline struct blkcg_gq *blkg_lookup(struct blkcg *blkcg, 
}



/**

 * blkg_to_pdata - get policy private data

 * blkg_to_pd - get policy private data

 * @blkg: blkg of interest

 * @pol: policy of interest

 *
@@ -287,7 +289,7 @@ static inline struct blkcg_policy_data *blkcg_to_cpd(struct blkcg *blkcg, 
}



/**

 * pdata_to_blkg - get blkg associated with policy private data

 * pd_to_blkg - get blkg associated with policy private data

 * @pd: policy private data of interest

 *

 * @pd is policy private data.  Determine the blkg it's associated with.