[PATCH -next] cifs: fix doc warnings in cifs_dfs_ref.c

[PATCH -next] cifs: fix doc warnings in cifs_dfs_ref.c

[Baokun Li]

Add description for `cifs_compose_mount_options` to fix the W=1 warnings:

 fs/cifs/cifs_dfs_ref.c:139: warning: Function parameter or
  member 'devname' not described in 'cifs_compose_mount_options'

Signed-off-by: Baokun Li <libaokun1@huawei.com>
---
 fs/cifs/cifs_dfs_ref.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/cifs/cifs_dfs_ref.c b/fs/cifs/cifs_dfs_ref.c
index c87c37cf2914..ec57cdb1590f 100644
--- a/fs/cifs/cifs_dfs_ref.c
+++ b/fs/cifs/cifs_dfs_ref.c
@@ -125,7 +125,7 @@ cifs_build_devname(char *nodename, const char *prepath)
  * @sb_mountdata:	parent/root DFS mount options (template)
  * @fullpath:		full path in UNC format
  * @ref:		optional server's referral
- *
+ * @devname:		return the built cifs device name if passed pointer not NULL
  * creates mount options for submount based on template options sb_mountdata
  * and replacing unc,ip,prefixpath options with ones we've got form ref_unc.
  *
-- 
2.31.1

Re: [PATCH -next] cifs: fix doc warnings in cifs_dfs_ref.c

[Steve French]

merged into cifs-2.6.git for-next

On Thu, Jun 10, 2021 at 6:39 AM Baokun Li <libaokun1@huawei.com> wrote:
>
> Add description for `cifs_compose_mount_options` to fix the W=1 warnings:
>
>  fs/cifs/cifs_dfs_ref.c:139: warning: Function parameter or
>   member 'devname' not described in 'cifs_compose_mount_options'
>
> Signed-off-by: Baokun Li <libaokun1@huawei.com>
> ---
>  fs/cifs/cifs_dfs_ref.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/fs/cifs/cifs_dfs_ref.c b/fs/cifs/cifs_dfs_ref.c
> index c87c37cf2914..ec57cdb1590f 100644
> --- a/fs/cifs/cifs_dfs_ref.c
> +++ b/fs/cifs/cifs_dfs_ref.c
> @@ -125,7 +125,7 @@ cifs_build_devname(char *nodename, const char *prepath)
>   * @sb_mountdata:      parent/root DFS mount options (template)
>   * @fullpath:          full path in UNC format
>   * @ref:               optional server's referral
> - *
> + * @devname:           return the built cifs device name if passed pointer not NULL
>   * creates mount options for submount based on template options sb_mountdata
>   * and replacing unc,ip,prefixpath options with ones we've got form ref_unc.
>   *
> --
> 2.31.1
>


-- 
Thanks,

Steve