Re: [PATCH] backing-file: fix backing_file_open() kerneldoc parameter

[Amir Goldstein]

On Tue, May 26, 2026 at 10:58 AM Li Wang <liwang@xxxxxxxxxx> wrote:
>
> 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 in the old comment.

typo: requested

>
> Signed-off-by: Li Wang <liwang@xxxxxxxxxx>

> ---
>  fs/backing-file.c | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/fs/backing-file.c b/fs/backing-file.c
> index 1f3bbfc75882..a530c2d19d20 100644
> --- a/fs/backing-file.c
> +++ b/fs/backing-file.c
> @@ -18,13 +18,14 @@
>
>  /**
>   * 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 opened on the stackable filesystem

@user_file: file the user requested to open

(It is not open yet)

>   * @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
> + * The user_path (taken from @user_file->f_path) may be

@user_file->f_path may be on the stackable filesystem and...

> + * 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

the path of the stackable filesystem...

>   * returned file into a container structure that also stores the stacked

Thanks,
Amir.