[RFC] fscache, 9p, afs, cifs, nfs: Deal with some warnings from W=1

Commit Message

Steve French Sept. 23, 2021, 7:08 p.m. UTC

Updated patch (just including the cifs change) to avoid merge conflicts.

Tentatively merged into cifs-2.6.git for-next

---------- Forwarded message ---------
From: David Howells <[e-mail]>
Date: Mon, Sep 20, 2021 at 9:39 AM
Subject: [RFC PATCH] fscache, 9p, afs, cifs, nfs: Deal with some
warnings from W=1
To: <[e-mail]>
Cc: Jeff Layton <[e-mail]>, Dominique Martinet
<[e-mail]>, Marc Dionne <[e-mail]>,
Steve French <[e-mail]>, Trond Myklebust
<[e-mail]>, Anna Schumaker
<[e-mail]>, Mauro Carvalho Chehab
<[e-mail]>, <[e-mail]>,
<[e-mail]>, <[e-mail]>,
<[e-mail]>, <[e-mail]>,
<[e-mail]>, <[e-mail]>


Deal with some warnings generated from make W=1:

 (1) Add/remove/fix kerneldoc parameters descriptions.

 (2) afs_sillyrename() isn't an API functions, so remove the kerneldoc
     annotation.

 (3) The fscache object CREATE_OBJECT work state isn't used, so remove it.

 (4) Move __add_fid() from between v9fs_fid_add() and its comment.

 (5) 9p's caches_show() doesn't really make sense as an API function, show
     remove the kerneldoc annotation.  It's also not prefixed with 'v9fs_'.

 (6) Remove the kerneldoc annotation on cifs_match_ipdaddr() as it's not
     fully documented.

 (7) Turn cifs' rqst_page_get_length()'s banner comment into a kerneldoc
     comment.  It should probably be prefixed with "cifs_" though.

Signed-off-by: David Howells <[e-mail]>
cc: Jeff Layton <[e-mail]>
cc: Dominique Martinet <[e-mail]>
cc: Marc Dionne <[e-mail]>
cc: Steve French <[e-mail]>
cc: Trond Myklebust <[e-mail]>
cc: Anna Schumaker <[e-mail]>
cc: Mauro Carvalho Chehab <[e-mail]>
cc: [e-mail]
cc: [e-mail]
cc: [e-mail]
cc: [e-mail]
cc: [e-mail]
cc: [e-mail]
---

 fs/9p/fid.c            |   14 +++++++-------
 fs/9p/v9fs.c           |    8 +++-----
 fs/9p/vfs_addr.c       |   13 +++++++++----
 fs/9p/vfs_file.c       |   33 ++++++++++++---------------------
 fs/9p/vfs_inode.c      |   24 ++++++++++++++++--------
 fs/9p/vfs_inode_dotl.c |   11 +++++++++--
 fs/afs/dir_silly.c     |    4 ++--
 fs/cifs/connect.c      |   14 +++++++++++++-
 fs/cifs/misc.c         |   14 ++++++++++++--
 fs/fscache/object.c    |    2 +-
 fs/fscache/operation.c |    3 +++
 fs/nfs_common/grace.c  |    1 -
 12 files changed, 87 insertions(+), 54 deletions(-)

Comments

David Howells Sept. 28, 2021, 8:46 a.m. UTC | #1

Steve French <[e-mail]> wrote:

> Updated patch (just including the cifs change) to avoid merge conflicts.
> 
> Tentatively merged into cifs-2.6.git for-next

I see your W=1 changes got merged and all my cifs bits are now gone.

David

Patch

From 03ab9cb982b622239cc2542ce7617b98a9ea159e Mon Sep 17 00:00:00 2001
From: David Howells <[e-mail]>
Date: Mon, 20 Sep 2021 13:14:15 +0100
Subject: [PATCH] cifs: Deal with some warnings from W=1

Deal with some warnings generated from make W=1:

 (1) Add/remove/fix kerneldoc parameters descriptions.

 (2) Turn cifs' rqst_page_get_length()'s banner comment into a kerneldoc
     comment.  It should probably be prefixed with "cifs_" though.

Signed-off-by: David Howells <[e-mail]>
Signed-off-by: Steve French <[e-mail]>
---
 fs/cifs/misc.c | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/fs/cifs/misc.c b/fs/cifs/misc.c
index 03da00eb7c04..f2916b51652a 100644
--- a/fs/cifs/misc.c
+++ b/fs/cifs/misc.c
@@ -590,6 +590,7 @@  void cifs_put_writer(struct cifsInodeInfo *cinode)
 
 /**
  * cifs_queue_oplock_break - queue the oplock break handler for cfile
+ * @cfile: The file to break the oplock on
  *
  * This function is called from the demultiplex thread when it
  * receives an oplock break for @cfile.
@@ -1065,6 +1066,9 @@  setup_aio_ctx_iter(struct cifs_aio_ctx *ctx, struct iov_iter *iter, int rw)
 
 /**
  * cifs_alloc_hash - allocate hash and hash context together
+ * @name: The name of the crypto hash algo
+ * @shash: Where to put the pointer to the hash algo
+ * @sdesc: Where to put the pointer to the hash descriptor
  *
  * The caller has to make sure @sdesc is initialized to either NULL or
  * a valid context. Both can be freed via cifs_free_hash().
@@ -1103,6 +1107,8 @@  cifs_alloc_hash(const char *name,
 
 /**
  * cifs_free_hash - free hash and hash context together
+ * @shash: Where to find the pointer to the hash algo
+ * @sdesc: Where to find the pointer to the hash descriptor
  *
  * Freeing a NULL hash or context is safe.
  */
@@ -1118,8 +1124,10 @@  cifs_free_hash(struct crypto_shash **shash, struct sdesc **sdesc)
 
 /**
  * rqst_page_get_length - obtain the length and offset for a page in smb_rqst
- * Input: rqst - a smb_rqst, page - a page index for rqst
- * Output: *len - the length for this page, *offset - the offset for this page
+ * @rqst: The request descriptor
+ * @page: The index of the page to query
+ * @len: Where to store the length for this page:
+ * @offset: Where to store the offset for this page
  */
 void rqst_page_get_length(struct smb_rqst *rqst, unsigned int page,
 				unsigned int *len, unsigned int *offset)
@@ -1152,6 +1160,8 @@  void extract_unc_hostname(const char *unc, const char **h, size_t *len)
 
 /**
  * copy_path_name - copy src path to dst, possibly truncating
+ * @dst: The destination buffer
+ * @src: The source name
  *
  * returns number of bytes written (including trailing nul)
  */
-- 
2.30.2