mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2026-06-21 15:43:21 +02:00
backing-file: fix backing_file_open() kerneldoc parameter
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>
This commit is contained in:
committed by
Christian Brauner
parent
de654d66ff
commit
aa5c4fe3ba
+7
-6
@@ -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,
|
||||
|
||||
Reference in New Issue
Block a user