Skip to content

Commit 017fb83

Browse files
bvanasscheaxboe
authored andcommitted
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' Cc: Christoph Hellwig <hch@lst.de> Fixes: 0718afd ("block: introduce holder ops") Fixes: cf056a4 ("init: improve the name_to_dev_t interface") Signed-off-by: Bart Van Assche <bvanassche@acm.org> Link: https://lore.kernel.org/r/20230621165054.743815-1-bvanassche@acm.org Signed-off-by: Jens Axboe <axboe@kernel.dk>
1 parent 2293cae commit 017fb83

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

block/bdev.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -561,6 +561,7 @@ static void bd_clear_claiming(struct block_device *whole, void *holder)
561561
* bd_finish_claiming - finish claiming of a block device
562562
* @bdev: block device of interest
563563
* @holder: holder that has claimed @bdev
564+
* @hops: block device holder operations
564565
*
565566
* Finish exclusive open of a block device. Mark the device as exlusively
566567
* open by the holder and wake up all waiters for exclusive open to finish.

block/early-lookup.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ static int __init match_dev_by_uuid(struct device *dev, const void *data)
3232
/**
3333
* devt_from_partuuid - looks up the dev_t of a partition by its UUID
3434
* @uuid_str: char array containing ascii UUID
35+
* @devt: dev_t result
3536
*
3637
* The function will return the first partition which contains a matching
3738
* 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)
4041
* If @uuid_str is followed by a "/PARTNROFF=%d", then the number will be
4142
* extracted and used as an offset from the partition identified by the UUID.
4243
*
43-
* Returns the matching dev_t on success or 0 on failure.
44+
* Returns 0 on success or a negative error code on failure.
4445
*/
4546
static int __init devt_from_partuuid(const char *uuid_str, dev_t *devt)
4647
{

0 commit comments

Comments
 (0)