]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
backing-file: fix backing_file_open() kerneldoc parameter
authorLi Wang <liwang@kylinos.cn>
Thu, 28 May 2026 10:42:08 +0000 (18:42 +0800)
committerChristian Brauner <brauner@kernel.org>
Wed, 10 Jun 2026 07:49:25 +0000 (09:49 +0200)
The kerneldoc for backing_file_open() documented a @user_path argument,
but the function takes const struct file *user_file. The user
path is derived as &user_file->f_path.

Update the @-tag to @user_file and adjust the description accordingly.
Also fix the "reuqested" typo to 'requested' in the old comment.

Signed-off-by: Li Wang <liwang@kylinos.cn>
Link: https://patch.msgid.link/20260528104208.395757-1-liwang@kylinos.cn
Reviewed-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Christian Brauner (Amutable) <brauner@kernel.org>
fs/backing-file.c

index 1f3bbfc758823fa024958f2efda5778f1d502c0c..080c99696cd0dc516dc1a5a4173b454783b1de6e 100644 (file)
 
 /**
  * backing_file_open - open a backing file for kernel internal use
- * @user_path: path that the user reuqested to open
+ * @user_file:  file the user requested to open
  * @flags:     open flags
  * @real_path: path of the backing file
  * @cred:      credentials for open
  *
  * Open a backing file for a stackable filesystem (e.g., overlayfs).
- * @user_path may be on the stackable filesystem and @real_path on the
- * underlying filesystem.  In this case, we want to be able to return the
- * @user_path of the stackable filesystem. This is done by embedding the
- * returned file into a container structure that also stores the stacked
- * file's path, which can be retrieved using backing_file_user_path().
+ * @user_file->f_path may be on the stackable filesystem and @real_path
+ * on the underlying filesystem. In this case, we want to be able to
+ * return the path of the stackable filesystem. This is done by
+ * embedding the returned file into a container structure that also
+ * stores the stacked file's path, which can be retrieved using
+ * backing_file_user_path().
  */
 struct file *backing_file_open(const struct file *user_file, int flags,
                               const struct path *real_path,