1. Patchew
  2. linux
  3. View series

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

Li Wang posted 1 patch 1 week, 6 days ago
There is a newer version of this series
fs/backing-file.c | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
[PATCH] backing-file: fix backing_file_open() kerneldoc parameter
Posted by Li Wang 1 week, 6 days ago 
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.

Signed-off-by: Li Wang <liwang@kylinos.cn>
---
 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
  * @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
+ * 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
-- 
2.34.1
Re: [PATCH] backing-file: fix backing_file_open() kerneldoc parameter
Posted by Amir Goldstein 1 week, 6 days ago 
On Tue, May 26, 2026 at 10:58 AM Li Wang <liwang@kylinos.cn> 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@kylinos.cn>

> ---
>  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.
[PATCH v2] backing-file: fix backing_file_open() kerneldoc parameter
Posted by Li Wang 1 week, 4 days ago 
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>
---
 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
Re: [PATCH v2] backing-file: fix backing_file_open() kerneldoc parameter
Posted by Amir Goldstein 3 days, 10 hours ago 
On Thu, May 28, 2026 at 12:42 PM Li Wang <liwang@kylinos.cn> 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@kylinos.cn>

Reviewed-by: Amir Goldstein <amir73il@gmail.com>

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

Patchew 2.1-devel-ea86937

© 2016 - 2026 Red Hat, Inc.