189 lines
7.0 KiB
Diff
189 lines
7.0 KiB
Diff
From fb0111b77bf45d069d7722682a1a1d202fbf5f7d Mon Sep 17 00:00:00 2001
|
|
From: Ondrej Mosnacek <omosnace@redhat.com>
|
|
Date: Wed, 3 Jun 2026 08:59:20 +0200
|
|
Subject: [PATCH] fs: Fix kernel-doc warnings
|
|
|
|
JIRA: https://issues.redhat.com/browse/RHEL-179443
|
|
CVE: CVE-2026-46054
|
|
Conflicts:
|
|
- fs/fs_context.c: one docstring fix was already applied
|
|
|
|
commit 35931eb3945b8d38c31f8e956aee3cf31c52121b
|
|
Author: Matthew Wilcox (Oracle) <willy@infradead.org>
|
|
Date: Fri Aug 18 21:08:24 2023 +0100
|
|
|
|
fs: Fix kernel-doc warnings
|
|
|
|
These have a variety of causes and a corresponding variety of solutions.
|
|
|
|
Signed-off-by: "Matthew Wilcox (Oracle)" <willy@infradead.org>
|
|
Message-Id: <20230818200824.2720007-1-willy@infradead.org>
|
|
Signed-off-by: Christian Brauner <brauner@kernel.org>
|
|
|
|
Signed-off-by: Ondrej Mosnacek <omosnace@redhat.com>
|
|
|
|
diff --git a/fs/file.c b/fs/file.c
|
|
index 236e11a38c18..70962ee8c68b 100644
|
|
--- a/fs/file.c
|
|
+++ b/fs/file.c
|
|
@@ -679,7 +679,7 @@ EXPORT_SYMBOL(close_fd); /* for ksys_close() */
|
|
|
|
/**
|
|
* last_fd - return last valid index into fd table
|
|
- * @cur_fds: files struct
|
|
+ * @fdt: File descriptor table.
|
|
*
|
|
* Context: Either rcu read lock or files_lock must be held.
|
|
*
|
|
@@ -734,6 +734,7 @@ static inline void __range_close(struct files_struct *cur_fds, unsigned int fd,
|
|
*
|
|
* @fd: starting file descriptor to close
|
|
* @max_fd: last file descriptor to close
|
|
+ * @flags: CLOSE_RANGE flags.
|
|
*
|
|
* This closes a range of file descriptors. All file descriptors
|
|
* from @fd up to and including @max_fd are closed.
|
|
diff --git a/fs/fs_context.c b/fs/fs_context.c
|
|
index 648d2ee9e5fc..3473e63e8399 100644
|
|
--- a/fs/fs_context.c
|
|
+++ b/fs/fs_context.c
|
|
@@ -162,6 +162,10 @@ EXPORT_SYMBOL(vfs_parse_fs_param);
|
|
|
|
/**
|
|
* vfs_parse_fs_string - Convenience function to just parse a string.
|
|
+ * @fc: Filesystem context.
|
|
+ * @key: Parameter name.
|
|
+ * @value: Default value.
|
|
+ * @v_size: Maximum number of bytes in the value.
|
|
*/
|
|
int vfs_parse_fs_string(struct fs_context *fc, const char *key,
|
|
const char *value, size_t v_size)
|
|
@@ -357,7 +361,7 @@ void fc_drop_locked(struct fs_context *fc)
|
|
static void legacy_fs_context_free(struct fs_context *fc);
|
|
|
|
/**
|
|
- * vfs_dup_fc_config: Duplicate a filesystem context.
|
|
+ * vfs_dup_fs_context - Duplicate a filesystem context.
|
|
* @src_fc: The context to copy.
|
|
*/
|
|
struct fs_context *vfs_dup_fs_context(struct fs_context *src_fc)
|
|
@@ -403,7 +407,9 @@ EXPORT_SYMBOL(vfs_dup_fs_context);
|
|
|
|
/**
|
|
* logfc - Log a message to a filesystem context
|
|
- * @fc: The filesystem context to log to.
|
|
+ * @log: The filesystem context to log to, or NULL to use printk.
|
|
+ * @prefix: A string to prefix the output with, or NULL.
|
|
+ * @level: 'w' for a warning, 'e' for an error. Anything else is a notice.
|
|
* @fmt: The format of the buffer.
|
|
*/
|
|
void logfc(struct fc_log *log, const char *prefix, char level, const char *fmt, ...)
|
|
diff --git a/fs/ioctl.c b/fs/ioctl.c
|
|
index 088462ee5a81..64776891120c 100644
|
|
--- a/fs/ioctl.c
|
|
+++ b/fs/ioctl.c
|
|
@@ -109,9 +109,6 @@ static int ioctl_fibmap(struct file *filp, int __user *p)
|
|
* Returns 0 on success, -errno on error, 1 if this was the last
|
|
* extent that will fit in user array.
|
|
*/
|
|
-#define SET_UNKNOWN_FLAGS (FIEMAP_EXTENT_DELALLOC)
|
|
-#define SET_NO_UNMOUNTED_IO_FLAGS (FIEMAP_EXTENT_DATA_ENCRYPTED)
|
|
-#define SET_NOT_ALIGNED_FLAGS (FIEMAP_EXTENT_DATA_TAIL|FIEMAP_EXTENT_DATA_INLINE)
|
|
int fiemap_fill_next_extent(struct fiemap_extent_info *fieinfo, u64 logical,
|
|
u64 phys, u64 len, u32 flags)
|
|
{
|
|
@@ -127,6 +124,10 @@ int fiemap_fill_next_extent(struct fiemap_extent_info *fieinfo, u64 logical,
|
|
if (fieinfo->fi_extents_mapped >= fieinfo->fi_extents_max)
|
|
return 1;
|
|
|
|
+#define SET_UNKNOWN_FLAGS (FIEMAP_EXTENT_DELALLOC)
|
|
+#define SET_NO_UNMOUNTED_IO_FLAGS (FIEMAP_EXTENT_DATA_ENCRYPTED)
|
|
+#define SET_NOT_ALIGNED_FLAGS (FIEMAP_EXTENT_DATA_TAIL|FIEMAP_EXTENT_DATA_INLINE)
|
|
+
|
|
if (flags & SET_UNKNOWN_FLAGS)
|
|
flags |= FIEMAP_EXTENT_UNKNOWN;
|
|
if (flags & SET_NO_UNMOUNTED_IO_FLAGS)
|
|
@@ -913,6 +914,9 @@ SYSCALL_DEFINE3(ioctl, unsigned int, fd, unsigned int, cmd, unsigned long, arg)
|
|
#ifdef CONFIG_COMPAT
|
|
/**
|
|
* compat_ptr_ioctl - generic implementation of .compat_ioctl file operation
|
|
+ * @file: The file to operate on.
|
|
+ * @cmd: The ioctl command number.
|
|
+ * @arg: The argument to the ioctl.
|
|
*
|
|
* This is not normally called as a function, but instead set in struct
|
|
* file_operations as
|
|
diff --git a/fs/kernel_read_file.c b/fs/kernel_read_file.c
|
|
index 5d826274570c..c429c42a6867 100644
|
|
--- a/fs/kernel_read_file.c
|
|
+++ b/fs/kernel_read_file.c
|
|
@@ -8,16 +8,16 @@
|
|
/**
|
|
* kernel_read_file() - read file contents into a kernel buffer
|
|
*
|
|
- * @file file to read from
|
|
- * @offset where to start reading from (see below).
|
|
- * @buf pointer to a "void *" buffer for reading into (if
|
|
+ * @file: file to read from
|
|
+ * @offset: where to start reading from (see below).
|
|
+ * @buf: pointer to a "void *" buffer for reading into (if
|
|
* *@buf is NULL, a buffer will be allocated, and
|
|
* @buf_size will be ignored)
|
|
- * @buf_size size of buf, if already allocated. If @buf not
|
|
+ * @buf_size: size of buf, if already allocated. If @buf not
|
|
* allocated, this is the largest size to allocate.
|
|
- * @file_size if non-NULL, the full size of @file will be
|
|
+ * @file_size: if non-NULL, the full size of @file will be
|
|
* written here.
|
|
- * @id the kernel_read_file_id identifying the type of
|
|
+ * @id: the kernel_read_file_id identifying the type of
|
|
* file contents being read (for LSMs to examine)
|
|
*
|
|
* @offset must be 0 unless both @buf and @file_size are non-NULL
|
|
diff --git a/fs/namei.c b/fs/namei.c
|
|
index 0a4b15d9a010..23c73afe57d3 100644
|
|
--- a/fs/namei.c
|
|
+++ b/fs/namei.c
|
|
@@ -644,6 +644,8 @@ static bool nd_alloc_stack(struct nameidata *nd)
|
|
|
|
/**
|
|
* path_connected - Verify that a dentry is below mnt.mnt_root
|
|
+ * @mnt: The mountpoint to check.
|
|
+ * @dentry: The dentry to check.
|
|
*
|
|
* Rename can sometimes move a file or directory outside of a bind
|
|
* mount, path_connected allows those cases to be detected.
|
|
@@ -1083,6 +1085,7 @@ fs_initcall(init_fs_namei_sysctls);
|
|
/**
|
|
* may_follow_link - Check symlink following for unsafe situations
|
|
* @nd: nameidata pathwalk data
|
|
+ * @inode: Used for idmapping.
|
|
*
|
|
* In the case of the sysctl_protected_symlinks sysctl being enabled,
|
|
* CAP_DAC_OVERRIDE needs to be specifically ignored if the symlink is
|
|
diff --git a/fs/open.c b/fs/open.c
|
|
index e2419242456e..ef2cc51d468c 100644
|
|
--- a/fs/open.c
|
|
+++ b/fs/open.c
|
|
@@ -1126,7 +1126,7 @@ EXPORT_SYMBOL_GPL(kernel_file_open);
|
|
* backing_file_open - open a backing file for kernel internal use
|
|
* @path: path of the file to open
|
|
* @flags: open flags
|
|
- * @path: path of the backing file
|
|
+ * @real_path: path of the backing file
|
|
* @cred: credentials for open
|
|
*
|
|
* Open a backing file for a stackable filesystem (e.g., overlayfs).
|
|
@@ -1534,7 +1534,7 @@ SYSCALL_DEFINE1(close, unsigned int, fd)
|
|
}
|
|
|
|
/**
|
|
- * close_range() - Close all file descriptors in a given range.
|
|
+ * sys_close_range() - Close all file descriptors in a given range.
|
|
*
|
|
* @fd: starting file descriptor to close
|
|
* @max_fd: last file descriptor to close
|
|
--
|
|
2.50.1 (Apple Git-155)
|
|
|