block: Improve kernel-doc headers
PATCH 1/1 block: Improve kernel-doc headers
Fix the documentation of the devt_from_partuuid() return value.
Fix the following two recently introduced kernel-doc warnings:
block/bdev.c:570: warning: Function parameter or member 'hops' not described in 'bd_finish_claiming' block/early-lookup.c:46: warning: Function parameter or member 'devt' not described in 'devt_from_partuuid'
--- block/bdev.c | 1 + block/early-lookup.c | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-)
block/bdev.c +1 -0
@@ -561,6 +561,7 @@ static void bd_clear_claiming(struct block_device *whole, void *holder)* bd_finish_claiming - finish claiming of a block device * @bdev: block device of interest * @holder: holder that has claimed @bdev +* @hops: block device holder operations * * Finish exclusive open of a block device. Mark the device as exlusively * open by the holder and wake up all waiters for exclusive open to finish.
block/early-lookup.c +2 -1
@@ -32,6 +32,7 @@ static int __init match_dev_by_uuid(struct device *dev, const void *data)/** * devt_from_partuuid - looks up the dev_t of a partition by its UUID * @uuid_str: char array containing ascii UUID +* @devt: dev_t result * * The function will return the first partition which contains a matching * UUID value in its partition_meta_info struct. This does not search
@@ -40,7 +41,7 @@ static int __init match_dev_by_uuid(struct device *dev, const void *data)* If @uuid_str is followed by a "/PARTNROFF=%d", then the number will be * extracted and used as an offset from the partition identified by the UUID. * -* Returns the matching dev_t on success or 0 on failure. +* Returns 0 on success or a negative error code on failure. */ static int __init devt_from_partuuid (const char *uuid_str,dev_t *devt) {
Quoted 8 lines · Bart Van Assche
Fix the documentation of the
devt_from_partuuid()return value.Fix the following two recently introduced kernel-doc warnings:
block/bdev.c:570: warning: Function parameter or member 'hops' not described in 'bd_finish_claiming'block/early-lookup.c:46: warning: Function parameter or member 'devt' not described in 'devt_from_partuuid'[...]
Applied, thanks!
[1/1] block: Improve kernel-doc headers
commit: 017fb83ee0612595ec70c65ddd83472706b02a50
Best regards,
Signature · 1 line
Jens Axboe