diff mbox series

[v3,03/14] btrfs: Fix function description format

Message ID 20210122095805.620458-4-nborisov@suse.com (mailing list archive)
State New, archived
Headers show
Series Make btrfs W=1 clean | expand

Commit Message

Nikolay Borisov Jan. 22, 2021, 9:57 a.m. UTC
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(-)

Comments

Johannes Thumshirn Jan. 22, 2021, 12:38 p.m. UTC | #1
On 22/01/2021 11:17, 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..784adae2d0f9 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
> + * Set inode's size according to filesystem options
> + *
> + * @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
> + * Marks a range within a file as having a new extent inserted
> + *
> + * @inode: the inode being modifying

being modified or we're modifying

> + * @start: the start file offset of the file extent we've inserted
> + * @len:   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
> + * Marks an inode range as not having a backing extent
> + *
> + * @inode: the inode being modifying

Same here

> + * @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
>
diff mbox series

Patch

diff --git a/fs/btrfs/file-item.c b/fs/btrfs/file-item.c
index 6ccfc019ad90..784adae2d0f9 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
+ * Set inode's size according to filesystem options
+ *
+ * @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
+ * Marks a range within a file as having a new extent inserted
+ *
+ * @inode: the inode being modifying
+ * @start: the start file offset of the file extent we've inserted
+ * @len:   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
+ * Marks an inode range as not having a backing extent
+ *
+ * @inode: the inode being 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