[PATCH 08/35] fs: Reorganize kerneldoc parameter names

Julia Lawall posted 35 patches 1 month, 4 weeks ago
[PATCH 08/35] fs: Reorganize kerneldoc parameter names
Posted by Julia Lawall 1 month, 4 weeks ago
Reorganize kerneldoc parameter names to match the parameter
order in the function header.

Problems identified using Coccinelle.

Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>

---
 fs/char_dev.c |    2 +-
 fs/dcache.c   |    4 ++--
 fs/seq_file.c |    2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/fs/char_dev.c b/fs/char_dev.c
index 57cc096c498a..c2ddb998f3c9 100644
--- a/fs/char_dev.c
+++ b/fs/char_dev.c
@@ -562,8 +562,8 @@ int cdev_device_add(struct cdev *cdev, struct device *dev)
 
 /**
  * cdev_device_del() - inverse of cdev_device_add
- * @dev: the device structure
  * @cdev: the cdev structure
+ * @dev: the device structure
  *
  * cdev_device_del() is a helper function to call cdev_del and device_del.
  * It should be used whenever cdev_device_add is used.
diff --git a/fs/dcache.c b/fs/dcache.c
index d7f6866f5f52..2894b30d8e40 100644
--- a/fs/dcache.c
+++ b/fs/dcache.c
@@ -2039,8 +2039,8 @@ EXPORT_SYMBOL(d_obtain_root);
 
 /**
  * d_add_ci - lookup or allocate new dentry with case-exact name
- * @inode:  the inode case-insensitive lookup has found
  * @dentry: the negative dentry that was passed to the parent's lookup func
+ * @inode:  the inode case-insensitive lookup has found
  * @name:   the case-exact name to be associated with the returned dentry
  *
  * This is to avoid filling the dcache with case-insensitive names to the
@@ -2093,8 +2093,8 @@ EXPORT_SYMBOL(d_add_ci);
 
 /**
  * d_same_name - compare dentry name with case-exact name
- * @parent: parent dentry
  * @dentry: the negative dentry that was passed to the parent's lookup func
+ * @parent: parent dentry
  * @name:   the case-exact name to be associated with the returned dentry
  *
  * Return: true if names are same, or false
diff --git a/fs/seq_file.c b/fs/seq_file.c
index e676c8b0cf5d..8bbb1ad46335 100644
--- a/fs/seq_file.c
+++ b/fs/seq_file.c
@@ -343,8 +343,8 @@ EXPORT_SYMBOL(seq_lseek);
 
 /**
  *	seq_release -	free the structures associated with sequential file.
- *	@file: file in question
  *	@inode: its inode
+ *	@file: file in question
  *
  *	Frees the structures associated with sequential file; can be used
  *	as ->f_op->release() if you don't have private data to destroy.
Re: [PATCH 08/35] fs: Reorganize kerneldoc parameter names
Posted by Jan Kara 1 month, 4 weeks ago
On Mon 30-09-24 13:20:54, Julia Lawall wrote:
> Reorganize kerneldoc parameter names to match the parameter
> order in the function header.
> 
> Problems identified using Coccinelle.
> 
> Signed-off-by: Julia Lawall <Julia.Lawall@inria.fr>

Looks good. Feel free to add:

Reviewed-by: Jan Kara <jack@suse.cz>

								Honza

> 
> ---
>  fs/char_dev.c |    2 +-
>  fs/dcache.c   |    4 ++--
>  fs/seq_file.c |    2 +-
>  3 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/fs/char_dev.c b/fs/char_dev.c
> index 57cc096c498a..c2ddb998f3c9 100644
> --- a/fs/char_dev.c
> +++ b/fs/char_dev.c
> @@ -562,8 +562,8 @@ int cdev_device_add(struct cdev *cdev, struct device *dev)
>  
>  /**
>   * cdev_device_del() - inverse of cdev_device_add
> - * @dev: the device structure
>   * @cdev: the cdev structure
> + * @dev: the device structure
>   *
>   * cdev_device_del() is a helper function to call cdev_del and device_del.
>   * It should be used whenever cdev_device_add is used.
> diff --git a/fs/dcache.c b/fs/dcache.c
> index d7f6866f5f52..2894b30d8e40 100644
> --- a/fs/dcache.c
> +++ b/fs/dcache.c
> @@ -2039,8 +2039,8 @@ EXPORT_SYMBOL(d_obtain_root);
>  
>  /**
>   * d_add_ci - lookup or allocate new dentry with case-exact name
> - * @inode:  the inode case-insensitive lookup has found
>   * @dentry: the negative dentry that was passed to the parent's lookup func
> + * @inode:  the inode case-insensitive lookup has found
>   * @name:   the case-exact name to be associated with the returned dentry
>   *
>   * This is to avoid filling the dcache with case-insensitive names to the
> @@ -2093,8 +2093,8 @@ EXPORT_SYMBOL(d_add_ci);
>  
>  /**
>   * d_same_name - compare dentry name with case-exact name
> - * @parent: parent dentry
>   * @dentry: the negative dentry that was passed to the parent's lookup func
> + * @parent: parent dentry
>   * @name:   the case-exact name to be associated with the returned dentry
>   *
>   * Return: true if names are same, or false
> diff --git a/fs/seq_file.c b/fs/seq_file.c
> index e676c8b0cf5d..8bbb1ad46335 100644
> --- a/fs/seq_file.c
> +++ b/fs/seq_file.c
> @@ -343,8 +343,8 @@ EXPORT_SYMBOL(seq_lseek);
>  
>  /**
>   *	seq_release -	free the structures associated with sequential file.
> - *	@file: file in question
>   *	@inode: its inode
> + *	@file: file in question
>   *
>   *	Frees the structures associated with sequential file; can be used
>   *	as ->f_op->release() if you don't have private data to destroy.
> 
-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR
Re: (subset) [PATCH 08/35] fs: Reorganize kerneldoc parameter names
Posted by Christian Brauner 1 month, 4 weeks ago
On Mon, 30 Sep 2024 13:20:54 +0200, Julia Lawall wrote:
> Reorganize kerneldoc parameter names to match the parameter
> order in the function header.
> 
> Problems identified using Coccinelle.
> 
> 

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

[08/35] fs: Reorganize kerneldoc parameter names
        https://git.kernel.org/vfs/vfs/c/513f3387a9f3