[PATCH] fs_parser: update mount_api doc to match function signature

[PATCH] fs_parser: update mount_api doc to match function signature

[Randy Dunlap]

Add the missing 'name' parameter to the mount_api documentation for
fs_validate_description().

Fixes: 96cafb9ccb15 ("fs_parser: remove fs_parameter_description name field")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Eric Sandeen <sandeen@redhat.com>
Cc: David Howells <dhowells@redhat.com>
Cc: Al Viro <viro@zeniv.linux.org.uk>
Cc: Christian Brauner <brauner@kernel.org>
Cc: Jan Kara <jack@suse.cz>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
---
 Documentation/filesystems/mount_api.rst |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20241122.orig/Documentation/filesystems/mount_api.rst
+++ linux-next-20241122/Documentation/filesystems/mount_api.rst
@@ -770,7 +770,8 @@ process the parameters it is given.
 
    * ::
 
-       bool fs_validate_description(const struct fs_parameter_description *desc);
+       bool fs_validate_description(const char *name,
+                                    const struct fs_parameter_description *desc);
 
      This performs some validation checks on a parameter description.  It
      returns true if the description is good and false if it is not.  It will

Re: [PATCH] fs_parser: update mount_api doc to match function signature

[Christian Brauner]

On Mon, 25 Nov 2024 13:50:21 -0800, Randy Dunlap wrote:
> Add the missing 'name' parameter to the mount_api documentation for
> fs_validate_description().
> 
> 

Applied to the vfs.fixes branch of the vfs/vfs.git tree.
Patches in the vfs.fixes branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.fixes

[1/1] fs_parser: update mount_api doc to match function signature
      https://git.kernel.org/vfs/vfs/c/c66f759832a8

Re: [PATCH] fs_parser: update mount_api doc to match function signature

[Jan Kara]

On Mon 25-11-24 13:50:21, Randy Dunlap wrote:
> Add the missing 'name' parameter to the mount_api documentation for
> fs_validate_description().
> 
> Fixes: 96cafb9ccb15 ("fs_parser: remove fs_parameter_description name field")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Eric Sandeen <sandeen@redhat.com>
> Cc: David Howells <dhowells@redhat.com>
> Cc: Al Viro <viro@zeniv.linux.org.uk>
> Cc: Christian Brauner <brauner@kernel.org>
> Cc: Jan Kara <jack@suse.cz>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org

Looks good. Feel free to add:

Reviewed-by: Jan Kara <jack@suse.cz>

								Honza

> ---
>  Documentation/filesystems/mount_api.rst |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> --- linux-next-20241122.orig/Documentation/filesystems/mount_api.rst
> +++ linux-next-20241122/Documentation/filesystems/mount_api.rst
> @@ -770,7 +770,8 @@ process the parameters it is given.
>  
>     * ::
>  
> -       bool fs_validate_description(const struct fs_parameter_description *desc);
> +       bool fs_validate_description(const char *name,
> +                                    const struct fs_parameter_description *desc);
>  
>       This performs some validation checks on a parameter description.  It
>       returns true if the description is good and false if it is not.  It will
-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR