[PATCH] bdev: Improve lookup_bdev documentation

[PATCH] bdev: Improve lookup_bdev documentation

[Matthew Wilcox (Oracle)]

Add a Context section and rewrite the rest to be clearer.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
---
 block/bdev.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/block/bdev.c b/block/bdev.c
index b1d087e5e205..b4780c211222 100644
--- a/block/bdev.c
+++ b/block/bdev.c
@@ -963,15 +963,15 @@ void blkdev_put(struct block_device *bdev, fmode_t mode)
 EXPORT_SYMBOL(blkdev_put);
 
 /**
- * lookup_bdev  - lookup a struct block_device by name
- * @pathname:	special file representing the block device
- * @dev:	return value of the block device's dev_t
+ * lookup_bdev() - Look up a struct block_device by name.
+ * @pathname: Name of the block device in the filesystem.
+ * @dev: Pointer to the block device's dev_t, if found.
  *
  * Lookup the block device's dev_t at @pathname in the current
- * namespace if possible and return it by @dev.
+ * namespace if possible and return it in @dev.
  *
- * RETURNS:
- * 0 if succeeded, errno otherwise.
+ * Context: May sleep.
+ * Return: 0 if succeeded, negative errno otherwise.
  */
 int lookup_bdev(const char *pathname, dev_t *dev)
 {
-- 
2.33.0

Re: [PATCH] bdev: Improve lookup_bdev documentation

[Christoph Hellwig]

On Mon, Dec 13, 2021 at 05:11:13PM +0000, Matthew Wilcox (Oracle) wrote:
> Add a Context section and rewrite the rest to be clearer.
> 
> Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>

Looks good,

Reviewed-by: Christoph Hellwig <hch@lst.de>

Re: [PATCH] bdev: Improve lookup_bdev documentation

[Nikolay Borisov]

On 13.12.21 г. 19:11, Matthew Wilcox (Oracle) wrote:
> Add a Context section and rewrite the rest to be clearer.
> 
> Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>

Reviewed-by: Nikolay Borisov <nborisov@suse.com>

Re: [PATCH] bdev: Improve lookup_bdev documentation

[Jens Axboe]

On Mon, 13 Dec 2021 17:11:13 +0000, Matthew Wilcox (Oracle) wrote:
> Add a Context section and rewrite the rest to be clearer.
> 
> 

Applied, thanks!

[1/1] bdev: Improve lookup_bdev documentation
      commit: 0ba4566cd8a4e645b542e6ddbe3dd26c85ad2408

Best regards,
-- 
Jens Axboe