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

[Amir Goldstein]

On Thu, May 28, 2026 at 12:42 PM 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 to 'requested' in the old comment.
>
> Signed-off-by: Li Wang <liwang@xxxxxxxxxx>

Reviewed-by: Amir Goldstein <amir73il@xxxxxxxxx>

> ---
>  fs/backing-file.c | 13 +++++++------
>  1 file 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,
> --
> 2.34.1
>