block: Minor comment fix
PATCH 1/1 block: Minor comment fix
Minor fix to the inline documentation of blk_release_queue().
Signed-off-by Geoff Levand <[email protected]>
---
Hi Jens,
Seems like this comment is in error.
-Geoff
block/blk-sysfs.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
block/blk-sysfs.c +2 -2
@@ -245,27 +245,27 @@ queue_attr_store(struct kobject *kobj, smutex_lock (&q->sysfs_lock);if (test_bit (QUEUE_FLAG_DEAD , &q->queue_flags)) {mutex_unlock (&q->sysfs_lock);return -ENOENT ; } res = entry->store (q, page, length);mutex_unlock (&q->sysfs_lock);return res; }/** -* blk_cleanup_queue: - release a &struct request_queue when it is no longer needed +* blk_release_queue: - release a &struct request_queue when it is no longer needed * @kobj: the kobj belonging of the request queue to be released * * Description: -* blk_cleanup_queue is the pair to blk_init_queue() or +* blk_release_queue is the pair to blk_init_queue() or * blk_queue_make_request(). It should be called when a request queue is * being released; typically when a block device is being de-registered. * Currently, its primary task it to free all the &struct request * structures that were allocated to the queue and the queue itself. * * Caveat: * Hopefully the low level driver will have finished any * outstanding requests first... **/ static void blk_release_queue (struct kobject *kobj) {
Quoted 1 line · Geoff Levand
Minor fix to the inline documentation of
blk_release_queue().
Well, yes and know. If you notice, it's actually not an exported function. Moving the documentation to blk_cleanup_queue() would be the right thing to do, with an added explanation on how blk_release_queue() actually does the real work once all references to the device has gone away.
Signature · 1 line
Jens Axboe