| Message ID | 20210119122649.187778-4-nborisov@suse.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Make btrfs W=1 clean | expand |
On Tue, Jan 19, 2021 at 02:26:39PM +0200, Nikolay Borisov wrote: > This fixes following W=1 warnings: > > fs/btrfs/file-item.c:27: warning: Cannot understand * @inode: the inode we want to update the disk_i_size for > on line 27 - I thought it was a doc line > fs/btrfs/file-item.c:65: warning: Cannot understand * @inode - the inode we're modifying > on line 65 - I thought it was a doc line > fs/btrfs/file-item.c:91: warning: Cannot understand * @inode - the inode we're modifying > on line 91 - I thought it was a doc line > > Signed-off-by: Nikolay Borisov <nborisov@suse.com> > --- > fs/btrfs/file-item.c | 22 ++++++++++++++-------- > 1 file changed, 14 insertions(+), 8 deletions(-) > > diff --git a/fs/btrfs/file-item.c b/fs/btrfs/file-item.c > index 6ccfc019ad90..868b27e887b1 100644 > --- a/fs/btrfs/file-item.c > +++ b/fs/btrfs/file-item.c > @@ -24,8 +24,10 @@ > PAGE_SIZE)) > > /** > - * @inode - the inode we want to update the disk_i_size for > - * @new_i_size - the i_size we want to set to, 0 if we use i_size > + * btrfs_inode_safe_disk_i_size_write This is the part I don't like about kdoc but as we've talked about that, we can use a less strict formatting and follow this scheme: /** * Function summary description in one or two sentences. * * @param1: description * @param2: description * * Long description of the function. * * Return value semantics */ The kdoc checker is fine with the first line and validates the arguments, which is what we want. The validator can be enabled at build time as well by adding cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $< to our Makefile. > + * > + * @inode: the inode we want to update the disk_i_size for > + * @new_i_size: the i_size we want to set to, 0 if we use i_size Please align the descriptions
diff --git a/fs/btrfs/file-item.c b/fs/btrfs/file-item.c index 6ccfc019ad90..868b27e887b1 100644 --- a/fs/btrfs/file-item.c +++ b/fs/btrfs/file-item.c @@ -24,8 +24,10 @@ PAGE_SIZE)) /** - * @inode - the inode we want to update the disk_i_size for - * @new_i_size - the i_size we want to set to, 0 if we use i_size + * btrfs_inode_safe_disk_i_size_write + * + * @inode: the inode we want to update the disk_i_size for + * @new_i_size: the i_size we want to set to, 0 if we use i_size * * With NO_HOLES set this simply sets the disk_is_size to whatever i_size_read() * returns as it is perfectly fine with a file that has holes without hole file @@ -62,9 +64,11 @@ void btrfs_inode_safe_disk_i_size_write(struct btrfs_inode *inode, u64 new_i_siz } /** - * @inode - the inode we're modifying - * @start - the start file offset of the file extent we've inserted - * @len - the logical length of the file extent item + * btrfs_inode_set_file_extent_range + * + * @inode: the inode we're modifying + * @start: the start file offset of the file extent we've inserted + * @len: the logical length of the file extent item * * Call when we are inserting a new file extent where there was none before. * Does not need to call this in the case where we're replacing an existing file @@ -88,9 +92,11 @@ int btrfs_inode_set_file_extent_range(struct btrfs_inode *inode, u64 start, } /** - * @inode - the inode we're modifying - * @start - the start file offset of the file extent we've inserted - * @len - the logical length of the file extent item + * btrfs_inode_clear_file_extent_range + * + * @inode: the inode we're modifying + * @start: the start file offset of the file extent we've inserted + * @len: the logical length of the file extent item * * Called when we drop a file extent, for example when we truncate. Doesn't * need to be called for cases where we're replacing a file extent, like when
This fixes following W=1 warnings: fs/btrfs/file-item.c:27: warning: Cannot understand * @inode: the inode we want to update the disk_i_size for on line 27 - I thought it was a doc line fs/btrfs/file-item.c:65: warning: Cannot understand * @inode - the inode we're modifying on line 65 - I thought it was a doc line fs/btrfs/file-item.c:91: warning: Cannot understand * @inode - the inode we're modifying on line 91 - I thought it was a doc line Signed-off-by: Nikolay Borisov <nborisov@suse.com> --- fs/btrfs/file-item.c | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-)