| From: Randy Dunlap <rdunlap@infradead.org> |
| Subject: freevxfs: bmap: fix kernel-doc warnings |
| Date: Thu, 7 Dec 2023 13:20:33 -0800 |
| |
| Fix -Wall kernel-doc warnings in vxfs_bmap.c: |
| |
| vxfs_bmap.c:44: warning: Function parameter or member 'bn' not described in 'vxfs_bmap_ext4' |
| vxfs_bmap.c:44: warning: Excess function parameter 'iblock' description in 'vxfs_bmap_ext4' |
| vxfs_bmap.c:108: warning: No description found for return value of 'vxfs_bmap_indir' |
| vxfs_bmap.c:187: warning: No description found for return value of 'vxfs_bmap_typed' |
| vxfs_bmap.c:251: warning: No description found for return value of 'vxfs_bmap1' |
| |
| Link: https://lkml.kernel.org/r/20231207212035.25345-1-rdunlap@infradead.org |
| Signed-off-by: Randy Dunlap <rdunlap@infradead.org> |
| Reviewed-by: Christoph Hellwig <hch@lst.de> |
| Signed-off-by: Andrew Morton <akpm@linux-foundation.org> |
| --- |
| |
| fs/freevxfs/vxfs_bmap.c | 8 ++++---- |
| 1 file changed, 4 insertions(+), 4 deletions(-) |
| |
| --- a/fs/freevxfs/vxfs_bmap.c~freevxfs-bmap-fix-kernel-doc-warnings |
| +++ a/fs/freevxfs/vxfs_bmap.c |
| @@ -29,7 +29,7 @@ vxfs_typdump(struct vxfs_typed *typ) |
| /** |
| * vxfs_bmap_ext4 - do bmap for ext4 extents |
| * @ip: pointer to the inode we do bmap for |
| - * @iblock: logical block. |
| + * @bn: logical block. |
| * |
| * Description: |
| * vxfs_bmap_ext4 performs the bmap operation for inodes with |
| @@ -97,7 +97,7 @@ fail_buf: |
| * vxfs_bmap_indir reads a &struct vxfs_typed at @indir |
| * and performs the type-defined action. |
| * |
| - * Return Value: |
| + * Returns: |
| * The physical block number on success, else Zero. |
| * |
| * Note: |
| @@ -179,7 +179,7 @@ out: |
| * Description: |
| * Performs the bmap operation for typed extents. |
| * |
| - * Return Value: |
| + * Returns: |
| * The physical block number on success, else Zero. |
| */ |
| static daddr_t |
| @@ -243,7 +243,7 @@ vxfs_bmap_typed(struct inode *ip, long i |
| * vxfs_bmap1 perfoms a logical to physical block mapping |
| * for vxfs-internal purposes. |
| * |
| - * Return Value: |
| + * Returns: |
| * The physical block number on success, else Zero. |
| */ |
| daddr_t |
| _ |