diff mbox series

ntfs: dir.c: fix kernel-doc function parameter warnings

Message ID 20231219045414.24670-1-rdunlap@infradead.org
State New
Headers
Series ntfs: dir.c: fix kernel-doc function parameter warnings |

Commit Message

Randy Dunlap Dec. 19, 2023, 4:54 a.m. UTC 
  Correct the kernel-doc function parameter warnings for function
ntfs_dir_fsync() to prevent the following kernel-doc warnings:

dir.c:1489: warning: Function parameter or member 'start' not described in 'ntfs_dir_fsync'
dir.c:1489: warning: Function parameter or member 'end' not described in 'ntfs_dir_fsync'
dir.c:1489: warning: Excess function parameter 'dentry' description in 'ntfs_dir_fsync'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Anton Altaparmakov <anton@tuxera.com>
Cc: Namjae Jeon <linkinjeon@kernel.org>
Cc: linux-ntfs-dev@lists.sourceforge.net
Cc: Andrew Morton <akpm@linux-foundation.org>
---
 fs/ntfs/dir.c |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Namjae Jeon Dec. 19, 2023, 7:45 a.m. UTC | #1 
2023-12-19 13:54 GMT+09:00, Randy Dunlap <rdunlap@infradead.org>:
> Correct the kernel-doc function parameter warnings for function
> ntfs_dir_fsync() to prevent the following kernel-doc warnings:
>
> dir.c:1489: warning: Function parameter or member 'start' not described in
> 'ntfs_dir_fsync'
> dir.c:1489: warning: Function parameter or member 'end' not described in
> 'ntfs_dir_fsync'
> dir.c:1489: warning: Excess function parameter 'dentry' description in
> 'ntfs_dir_fsync'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Anton Altaparmakov <anton@tuxera.com>
> Cc: Namjae Jeon <linkinjeon@kernel.org>
> Cc: linux-ntfs-dev@lists.sourceforge.net
> Cc: Andrew Morton <akpm@linux-foundation.org>
As you may already know, the same warning is probably coming from
ntfs_file_fsync() in file.c.
Reviewed-by: Namjae Jeon <linkinjeon@kernel.org>
Thanks!
> ---
>  fs/ntfs/dir.c |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff -- a/fs/ntfs/dir.c b/fs/ntfs/dir.c
> --- a/fs/ntfs/dir.c
> +++ b/fs/ntfs/dir.c
> @@ -1462,7 +1462,8 @@ static int ntfs_dir_open(struct inode *v
>  /**
>   * ntfs_dir_fsync - sync a directory to disk
>   * @filp:	directory to be synced
> - * @dentry:	dentry describing the directory to sync
> + * @start:	offset in bytes of the beginning of data range to sync
> + * @end:	offset in bytes of the end of data range (inclusive)
>   * @datasync:	if non-zero only flush user data and not metadata
>   *
>   * Data integrity sync of a directory to disk.  Used for fsync, fdatasync,
> and
>
Christian Brauner Dec. 19, 2023, 1:07 p.m. UTC | #2 
On Mon, 18 Dec 2023 20:54:14 -0800, Randy Dunlap wrote:
> Correct the kernel-doc function parameter warnings for function
> ntfs_dir_fsync() to prevent the following kernel-doc warnings:
> 
> dir.c:1489: warning: Function parameter or member 'start' not described in 'ntfs_dir_fsync'
> dir.c:1489: warning: Function parameter or member 'end' not described in 'ntfs_dir_fsync'
> dir.c:1489: warning: Excess function parameter 'dentry' description in 'ntfs_dir_fsync'
> 
> [...]

Applied to the vfs.misc branch of the vfs/vfs.git tree.
Patches in the vfs.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.misc

[1/1] ntfs: dir.c: fix kernel-doc function parameter warnings
      https://git.kernel.org/vfs/vfs/c/be4887a964e2
diff mbox series

Patch

diff -- a/fs/ntfs/dir.c b/fs/ntfs/dir.c
--- a/fs/ntfs/dir.c
+++ b/fs/ntfs/dir.c
@@ -1462,7 +1462,8 @@  static int ntfs_dir_open(struct inode *v
 /**
  * ntfs_dir_fsync - sync a directory to disk
  * @filp:	directory to be synced
- * @dentry:	dentry describing the directory to sync
+ * @start:	offset in bytes of the beginning of data range to sync
+ * @end:	offset in bytes of the end of data range (inclusive)
  * @datasync:	if non-zero only flush user data and not metadata
  *
  * Data integrity sync of a directory to disk.  Used for fsync, fdatasync, and