diff mbox series

fs: fix f_ref kernel-doc struct member name

Message ID 20241017022536.58966-1-rdunlap@infradead.org (mailing list archive)
State New
Headers show
Series fs: fix f_ref kernel-doc struct member name | expand

Commit Message

Randy Dunlap Oct. 17, 2024, 2:25 a.m. UTC
Eliminate 2 kernel-doc warnings by using the correct struct member name:

include/linux/fs.h:1071: warning: Function parameter or struct member 'f_ref' not described in 'file'
include/linux/fs.h:1071: warning: Excess struct member 'f_count' description in 'file'

Fixes: c0390d541128 ("fs: pack struct file")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: Christian Brauner <brauner@kernel.org>
---
L: linux-fsdevel@vger.kernel.org
L: patches@lists.linux.dev

 include/linux/fs.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Christian Brauner Oct. 17, 2024, 9:19 a.m. UTC | #1
On Wed, 16 Oct 2024 19:25:36 -0700, Randy Dunlap wrote:
> Eliminate 2 kernel-doc warnings by using the correct struct member name:
> 
> include/linux/fs.h:1071: warning: Function parameter or struct member 'f_ref' not described in 'file'
> include/linux/fs.h:1071: warning: Excess struct member 'f_count' description in 'file'
> 
> 

Applied to the vfs.file branch of the vfs/vfs.git tree.
Patches in the vfs.file 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.file

[1/1] fs: fix f_ref kernel-doc struct member name
      https://git.kernel.org/vfs/vfs/c/babb8e98753a
diff mbox series

Patch

--- linux-next-20241016.orig/include/linux/fs.h
+++ linux-next-20241016/include/linux/fs.h
@@ -1006,7 +1006,7 @@  static inline int ra_has_index(struct fi
 
 /**
  * struct file - Represents a file
- * @f_count: reference count
+ * @f_ref: reference count
  * @f_lock: Protects f_ep, f_flags. Must not be taken from IRQ context.
  * @f_mode: FMODE_* flags often used in hotpaths
  * @f_op: file operations