Message ID | 20190531000053.64053-6-bvanassche@acm.org (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | Improve block layer function documentation | expand |
Looks good. Reviewed-by: Chaitanya Kulkarni <chiatanya.kulkarni@wdc.com> On 5/30/19 5:01 PM, Bart Van Assche wrote: > Add documentation for the @rqw argument and change " - " into ": ". > > Fixes: 84f603246db9 ("block: add rq_qos_wait to rq_qos") # v5.0-rc1~52^2~140. > Signed-off-by: Bart Van Assche <bvanassche@acm.org> > --- > block/blk-rq-qos.c | 7 ++++--- > 1 file changed, 4 insertions(+), 3 deletions(-) > > diff --git a/block/blk-rq-qos.c b/block/blk-rq-qos.c > index 3f55b56f24bc..659ccb8b693f 100644 > --- a/block/blk-rq-qos.c > +++ b/block/blk-rq-qos.c > @@ -209,9 +209,10 @@ static int rq_qos_wake_function(struct wait_queue_entry *curr, > > /** > * rq_qos_wait - throttle on a rqw if we need to > - * @private_data - caller provided specific data > - * @acquire_inflight_cb - inc the rqw->inflight counter if we can > - * @cleanup_cb - the callback to cleanup in case we race with a waker > + * @rqw: rqw to throttle on > + * @private_data: caller provided specific data > + * @acquire_inflight_cb: inc the rqw->inflight counter if we can > + * @cleanup_cb: the callback to cleanup in case we race with a waker > * > * This provides a uniform place for the rq_qos users to do their throttling. > * Since you can end up with a lot of things sleeping at once, this manages the >
diff --git a/block/blk-rq-qos.c b/block/blk-rq-qos.c index 3f55b56f24bc..659ccb8b693f 100644 --- a/block/blk-rq-qos.c +++ b/block/blk-rq-qos.c @@ -209,9 +209,10 @@ static int rq_qos_wake_function(struct wait_queue_entry *curr, /** * rq_qos_wait - throttle on a rqw if we need to - * @private_data - caller provided specific data - * @acquire_inflight_cb - inc the rqw->inflight counter if we can - * @cleanup_cb - the callback to cleanup in case we race with a waker + * @rqw: rqw to throttle on + * @private_data: caller provided specific data + * @acquire_inflight_cb: inc the rqw->inflight counter if we can + * @cleanup_cb: the callback to cleanup in case we race with a waker * * This provides a uniform place for the rq_qos users to do their throttling. * Since you can end up with a lot of things sleeping at once, this manages the
Add documentation for the @rqw argument and change " - " into ": ". Fixes: 84f603246db9 ("block: add rq_qos_wait to rq_qos") # v5.0-rc1~52^2~140. Signed-off-by: Bart Van Assche <bvanassche@acm.org> --- block/blk-rq-qos.c | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)