diff options
| author | Li Wang <liwang@kylinos.cn> | 2026-05-28 18:42:08 +0800 |
|---|---|---|
| committer | Christian Brauner <brauner@kernel.org> | 2026-06-10 09:49:25 +0200 |
| commit | aa5c4fe3ba0cb2af90bbcfa7a8ef4fefcd5c2370 (patch) | |
| tree | 4106f6fdf663028fff46b3f281f0c424ce14b3c1 | |
| parent | de654d66ff30e75d9308fd4d4f1627addef7923e (diff) | |
backing-file: fix backing_file_open() kerneldoc parameterrefs/merge-window/ff01ee92fd1554bdb7e1df2b9532690e425f3b81
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>
| -rw-r--r-- | fs/backing-file.c | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/fs/backing-file.c b/fs/backing-file.c index 1f3bbfc75882..080c99696cd0 100644 --- a/fs/backing-file.c +++ b/fs/backing-file.c @@ -18,17 +18,18 @@ /** * 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, |