diff mbox series

[net-next] net: 9p: Fix kerneldoc warnings of missing parameters etc

Message ID 20201031182655.1082065-1-andrew@lunn.ch
State Accepted
Delegated to: David Miller
Headers show
Series [net-next] net: 9p: Fix kerneldoc warnings of missing parameters etc | expand

Checks

Context Check Description
jkicinski/stable success Stable not CCed
jkicinski/header_inline success Link
jkicinski/build_allmodconfig_warn success Errors and warnings before: 21 this patch: 4
jkicinski/checkpatch success total: 0 errors, 0 warnings, 0 checks, 86 lines checked
jkicinski/verify_fixes success Link
jkicinski/kdoc success Errors and warnings before: 0 this patch: 0
jkicinski/build_32bit success Errors and warnings before: 21 this patch: 4
jkicinski/module_param success Was 0 now: 0
jkicinski/verify_signedoff success Link
jkicinski/source_inline success Was 0 now: 0
jkicinski/subject_prefix success Link
jkicinski/tree_selection success Clearly marked for net-next
jkicinski/patch_count success Link
jkicinski/fixes_present success Link
jkicinski/cover_letter success Link

Commit Message

Andrew Lunn Oct. 31, 2020, 6:26 p.m. UTC
net/9p/client.c:420: warning: Function parameter or member 'c' not described in 'p9_client_cb'
net/9p/client.c:420: warning: Function parameter or member 'req' not described in 'p9_client_cb'
net/9p/client.c:420: warning: Function parameter or member 'status' not described in 'p9_client_cb'
net/9p/client.c:568: warning: Function parameter or member 'uidata' not described in 'p9_check_zc_errors'
net/9p/trans_common.c:23: warning: Function parameter or member 'nr_pages' not described in 'p9_release_pages'
net/9p/trans_common.c:23: warning: Function parameter or member 'pages' not described in 'p9_release_pages'
net/9p/trans_fd.c:132: warning: Function parameter or member 'rreq' not described in 'p9_conn'
net/9p/trans_fd.c:132: warning: Function parameter or member 'wreq' not described in 'p9_conn'
net/9p/trans_fd.c:56: warning: Function parameter or member 'privport' not described in 'p9_fd_opts'
net/9p/trans_rdma.c:113: warning: Function parameter or member 'cqe' not described in 'p9_rdma_context'
net/9p/trans_rdma.c:129: warning: Function parameter or member 'privport' not described in 'p9_rdma_opts'
net/9p/trans_virtio.c:215: warning: Function parameter or member 'limit' not described in 'pack_sg_list_p'
net/9p/trans_virtio.c:83: warning: Function parameter or member 'chan_list' not described in 'virtio_chan'
net/9p/trans_virtio.c:83: warning: Function parameter or member 'p9_max_pages' not described in 'virtio_chan'
net/9p/trans_virtio.c:83: warning: Function parameter or member 'ring_bufs_avail' not described in 'virtio_chan'
net/9p/trans_virtio.c:83: warning: Function parameter or member 'tag' not described in 'virtio_chan'
net/9p/trans_virtio.c:83: warning: Function parameter or member 'vc_wq' not described in 'virtio_chan'

Signed-off-by: Andrew Lunn <andrew@lunn.ch>
---
 net/9p/client.c       | 6 ++++--
 net/9p/trans_common.c | 4 +++-
 net/9p/trans_fd.c     | 4 +++-
 net/9p/trans_rdma.c   | 2 ++
 net/9p/trans_virtio.c | 9 +++++++--
 5 files changed, 19 insertions(+), 6 deletions(-)

Comments

Dominique Martinet Oct. 31, 2020, 8:58 p.m. UTC | #1
Andrew Lunn wrote on Sat, Oct 31, 2020:
> net/9p/client.c:420: warning: Function parameter or member 'c' not described in 'p9_client_cb'
> net/9p/client.c:420: warning: Function parameter or member 'req' not described in 'p9_client_cb'
> net/9p/client.c:420: warning: Function parameter or member 'status' not described in 'p9_client_cb'
> net/9p/client.c:568: warning: Function parameter or member 'uidata' not described in 'p9_check_zc_errors'
> net/9p/trans_common.c:23: warning: Function parameter or member 'nr_pages' not described in 'p9_release_pages'
> net/9p/trans_common.c:23: warning: Function parameter or member 'pages' not described in 'p9_release_pages'
> net/9p/trans_fd.c:132: warning: Function parameter or member 'rreq' not described in 'p9_conn'
> net/9p/trans_fd.c:132: warning: Function parameter or member 'wreq' not described in 'p9_conn'
> net/9p/trans_fd.c:56: warning: Function parameter or member 'privport' not described in 'p9_fd_opts'
> net/9p/trans_rdma.c:113: warning: Function parameter or member 'cqe' not described in 'p9_rdma_context'
> net/9p/trans_rdma.c:129: warning: Function parameter or member 'privport' not described in 'p9_rdma_opts'
> net/9p/trans_virtio.c:215: warning: Function parameter or member 'limit' not described in 'pack_sg_list_p'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'chan_list' not described in 'virtio_chan'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'p9_max_pages' not described in 'virtio_chan'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'ring_bufs_avail' not described in 'virtio_chan'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'tag' not described in 'virtio_chan'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'vc_wq' not described in 'virtio_chan'
> 
> Signed-off-by: Andrew Lunn <andrew@lunn.ch>

Thanks, LGTM I'll take this for next cycle unless someone is grabbing
these
Andrew Lunn Nov. 1, 2020, 3:54 p.m. UTC | #2
On Sat, Oct 31, 2020 at 09:58:13PM +0100, Dominique Martinet wrote:
> Andrew Lunn wrote on Sat, Oct 31, 2020:
> > net/9p/client.c:420: warning: Function parameter or member 'c' not described in 'p9_client_cb'
> > net/9p/client.c:420: warning: Function parameter or member 'req' not described in 'p9_client_cb'
> > net/9p/client.c:420: warning: Function parameter or member 'status' not described in 'p9_client_cb'
> > net/9p/client.c:568: warning: Function parameter or member 'uidata' not described in 'p9_check_zc_errors'
> > net/9p/trans_common.c:23: warning: Function parameter or member 'nr_pages' not described in 'p9_release_pages'
> > net/9p/trans_common.c:23: warning: Function parameter or member 'pages' not described in 'p9_release_pages'
> > net/9p/trans_fd.c:132: warning: Function parameter or member 'rreq' not described in 'p9_conn'
> > net/9p/trans_fd.c:132: warning: Function parameter or member 'wreq' not described in 'p9_conn'
> > net/9p/trans_fd.c:56: warning: Function parameter or member 'privport' not described in 'p9_fd_opts'
> > net/9p/trans_rdma.c:113: warning: Function parameter or member 'cqe' not described in 'p9_rdma_context'
> > net/9p/trans_rdma.c:129: warning: Function parameter or member 'privport' not described in 'p9_rdma_opts'
> > net/9p/trans_virtio.c:215: warning: Function parameter or member 'limit' not described in 'pack_sg_list_p'
> > net/9p/trans_virtio.c:83: warning: Function parameter or member 'chan_list' not described in 'virtio_chan'
> > net/9p/trans_virtio.c:83: warning: Function parameter or member 'p9_max_pages' not described in 'virtio_chan'
> > net/9p/trans_virtio.c:83: warning: Function parameter or member 'ring_bufs_avail' not described in 'virtio_chan'
> > net/9p/trans_virtio.c:83: warning: Function parameter or member 'tag' not described in 'virtio_chan'
> > net/9p/trans_virtio.c:83: warning: Function parameter or member 'vc_wq' not described in 'virtio_chan'
> > 
> > Signed-off-by: Andrew Lunn <andrew@lunn.ch>
> 
> Thanks, LGTM I'll take this for next cycle unless someone is grabbing
> these

Hi Dominique

I hope to turn on W=1 by default soon in most of /net. That patch is
likely to go to net-next.

What route do your patches normally take to Linus? Do you send a pull
request to net-next? Or straight to Linus?

If this patch is not in net-next, i cannot enable it for 9p. So
either:

1) I leave 9p without W=1, and there is a risk it gains new warnings
   which nobody notices

2) I send the W=1 enablement for 9p to you, but it does nothing in
   your tree because you don't have the rest of the patches. Any new
   warnings will appear in next, assuming 9p is merged into next, i've
   not checked that.

3) I expect there to be a stable branch with the base patches needed
   for W=1 by default. You can pull that into your tree, along with a
   patch to actually enable it in 9p. You then get to know about new
   warnings.

4) Jakub takes this patch into net-next, and i can then enable W=1 in
   9p along with all the other sub-directories. We will get to know
   about new warnings in net-next, and next, but not in your tree.

   Andrew
Dominique Martinet Nov. 1, 2020, 4:08 p.m. UTC | #3
Andrew Lunn wrote on Sun, Nov 01, 2020:
> > > Signed-off-by: Andrew Lunn <andrew@lunn.ch>

Acked-by: Dominique Martinet <asmadeus@codewreck.org>

> > 
> > Thanks, LGTM I'll take this for next cycle unless someone is grabbing
> > these
> 
> I hope to turn on W=1 by default soon in most of /net. That patch is
> likely to go to net-next.

That would be nice!

> What route do your patches normally take to Linus? Do you send a pull
> request to net-next? Or straight to Linus?

I normally send pull requests straight to Linus (because I also have
fs/9p which isn't part of net/) ; but since it's really low volume I
don't like bugging him everytime for such churn and am not really sure
what to do -- that's why I asked :)

> If this patch is not in net-next, i cannot enable it for 9p. So
> either:
> [...]
> 4) Jakub takes this patch into net-next, and i can then enable W=1 in
>    9p along with all the other sub-directories. We will get to know
>    about new warnings in net-next, and next, but not in your tree.

Developers should use next for development anyway; I think that's the
easiest way forward if you want to enable W=1 ASAP.

I mean, if I take the patch the fixes will get in next in the next few
days sure but it'll make enabling W=1 difficult for the net-next tree
without it.
I've added Jakub to direct recipients, could you take this one?


Thanks,
Jakub Kicinski Nov. 2, 2020, 8:27 p.m. UTC | #4
On Sun, 1 Nov 2020 17:08:25 +0100 Dominique Martinet wrote:
> Andrew Lunn wrote on Sun, Nov 01, 2020:
> > > > Signed-off-by: Andrew Lunn <andrew@lunn.ch>  
> 
> Acked-by: Dominique Martinet <asmadeus@codewreck.org>
> 
> > > 
> > > Thanks, LGTM I'll take this for next cycle unless someone is grabbing
> > > these  
> > 
> > I hope to turn on W=1 by default soon in most of /net. That patch is
> > likely to go to net-next.  
> 
> That would be nice!
> 
> > What route do your patches normally take to Linus? Do you send a pull
> > request to net-next? Or straight to Linus?  
> 
> I normally send pull requests straight to Linus (because I also have
> fs/9p which isn't part of net/) ; but since it's really low volume I
> don't like bugging him everytime for such churn and am not really sure
> what to do -- that's why I asked :)
> 
> > If this patch is not in net-next, i cannot enable it for 9p. So
> > either:
> > [...]
> > 4) Jakub takes this patch into net-next, and i can then enable W=1 in
> >    9p along with all the other sub-directories. We will get to know
> >    about new warnings in net-next, and next, but not in your tree.  
> 
> Developers should use next for development anyway; I think that's the
> easiest way forward if you want to enable W=1 ASAP.
> 
> I mean, if I take the patch the fixes will get in next in the next few
> days sure but it'll make enabling W=1 difficult for the net-next tree
> without it.
> I've added Jakub to direct recipients, could you take this one?

Sure - to net-next it goes, thanks!
patchwork-bot+netdevbpf@kernel.org Nov. 2, 2020, 8:30 p.m. UTC | #5
Hello:

This patch was applied to netdev/net-next.git (refs/heads/master):

On Sat, 31 Oct 2020 19:26:55 +0100 you wrote:
> net/9p/client.c:420: warning: Function parameter or member 'c' not described in 'p9_client_cb'
> net/9p/client.c:420: warning: Function parameter or member 'req' not described in 'p9_client_cb'
> net/9p/client.c:420: warning: Function parameter or member 'status' not described in 'p9_client_cb'
> net/9p/client.c:568: warning: Function parameter or member 'uidata' not described in 'p9_check_zc_errors'
> net/9p/trans_common.c:23: warning: Function parameter or member 'nr_pages' not described in 'p9_release_pages'
> net/9p/trans_common.c:23: warning: Function parameter or member 'pages' not described in 'p9_release_pages'
> net/9p/trans_fd.c:132: warning: Function parameter or member 'rreq' not described in 'p9_conn'
> net/9p/trans_fd.c:132: warning: Function parameter or member 'wreq' not described in 'p9_conn'
> net/9p/trans_fd.c:56: warning: Function parameter or member 'privport' not described in 'p9_fd_opts'
> net/9p/trans_rdma.c:113: warning: Function parameter or member 'cqe' not described in 'p9_rdma_context'
> net/9p/trans_rdma.c:129: warning: Function parameter or member 'privport' not described in 'p9_rdma_opts'
> net/9p/trans_virtio.c:215: warning: Function parameter or member 'limit' not described in 'pack_sg_list_p'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'chan_list' not described in 'virtio_chan'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'p9_max_pages' not described in 'virtio_chan'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'ring_bufs_avail' not described in 'virtio_chan'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'tag' not described in 'virtio_chan'
> net/9p/trans_virtio.c:83: warning: Function parameter or member 'vc_wq' not described in 'virtio_chan'
> 
> [...]

Here is the summary with links:
  - [net-next] net: 9p: Fix kerneldoc warnings of missing parameters etc
    https://git.kernel.org/netdev/net-next/c/760b3d61fb4e

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html
diff mbox series

Patch

diff --git a/net/9p/client.c b/net/9p/client.c
index 09f1ec589b80..785a7bb6a539 100644
--- a/net/9p/client.c
+++ b/net/9p/client.c
@@ -412,8 +412,9 @@  static void p9_tag_cleanup(struct p9_client *c)
 
 /**
  * p9_client_cb - call back from transport to client
- * c: client state
- * req: request received
+ * @c: client state
+ * @req: request received
+ * @status: request status, one of REQ_STATUS_*
  *
  */
 void p9_client_cb(struct p9_client *c, struct p9_req_t *req, int status)
@@ -555,6 +556,7 @@  static int p9_check_errors(struct p9_client *c, struct p9_req_t *req)
  * p9_check_zc_errors - check 9p packet for error return and process it
  * @c: current client instance
  * @req: request to parse and check for error conditions
+ * @uidata: external buffer containing error
  * @in_hdrlen: Size of response protocol buffer.
  *
  * returns error code if one is discovered, otherwise returns 0
diff --git a/net/9p/trans_common.c b/net/9p/trans_common.c
index 3dff68f05fb9..6ea5ea548cd4 100644
--- a/net/9p/trans_common.c
+++ b/net/9p/trans_common.c
@@ -17,7 +17,9 @@ 
 #include "trans_common.h"
 
 /**
- *  p9_release_pages - Release pages after the transaction.
+ * p9_release_pages - Release pages after the transaction.
+ * @pages: array of pages to be put
+ * @nr_pages: size of array
  */
 void p9_release_pages(struct page **pages, int nr_pages)
 {
diff --git a/net/9p/trans_fd.c b/net/9p/trans_fd.c
index 8f528e783a6c..fa158397bb63 100644
--- a/net/9p/trans_fd.c
+++ b/net/9p/trans_fd.c
@@ -45,7 +45,7 @@  static struct p9_trans_module p9_fd_trans;
  * @rfd: file descriptor for reading (trans=fd)
  * @wfd: file descriptor for writing (trans=fd)
  * @port: port to connect to (trans=tcp)
- *
+ * @privport: port is privileged
  */
 
 struct p9_fd_opts {
@@ -95,6 +95,8 @@  struct p9_poll_wait {
  * @err: error state
  * @req_list: accounting for requests which have been sent
  * @unsent_req_list: accounting for requests that haven't been sent
+ * @rreq: read request
+ * @wreq: write request
  * @req: current request being processed (if any)
  * @tmp_buf: temporary buffer to read in header
  * @rc: temporary fcall for reading current frame
diff --git a/net/9p/trans_rdma.c b/net/9p/trans_rdma.c
index 2885ff9c76f0..af0a8a6cd3fd 100644
--- a/net/9p/trans_rdma.c
+++ b/net/9p/trans_rdma.c
@@ -99,6 +99,7 @@  struct p9_rdma_req;
 /**
  * struct p9_rdma_context - Keeps track of in-process WR
  *
+ * @cqe: completion queue entry
  * @busa: Bus address to unmap when the WR completes
  * @req: Keeps track of requests (send)
  * @rc: Keepts track of replies (receive)
@@ -115,6 +116,7 @@  struct p9_rdma_context {
 /**
  * struct p9_rdma_opts - Collection of mount options
  * @port: port of connection
+ * @privport: Whether a privileged port may be used
  * @sq_depth: The requested depth of the SQ. This really doesn't need
  * to be any deeper than the number of threads used in the client
  * @rq_depth: The depth of the RQ. Should be greater than or equal to SQ depth
diff --git a/net/9p/trans_virtio.c b/net/9p/trans_virtio.c
index a3cd90a74012..93f2f8654882 100644
--- a/net/9p/trans_virtio.c
+++ b/net/9p/trans_virtio.c
@@ -50,7 +50,11 @@  static atomic_t vp_pinned = ATOMIC_INIT(0);
  * @client: client instance
  * @vdev: virtio dev associated with this channel
  * @vq: virtio queue associated with this channel
+ * @ring_bufs_avail: flag to indicate there is some available in the ring buf
+ * @vc_wq: wait queue for waiting for thing to be added to ring buf
+ * @p9_max_pages: maximum number of pinned pages
  * @sg: scatter gather list which is used to pack a request (protected?)
+ * @chan_list: linked list of channels
  *
  * We keep all per-channel information in a structure.
  * This structure is allocated within the devices dev->mem space.
@@ -74,8 +78,8 @@  struct virtio_chan {
 	unsigned long p9_max_pages;
 	/* Scatterlist: can be too big for stack. */
 	struct scatterlist sg[VIRTQUEUE_NUM];
-	/*
-	 * tag name to identify a mount null terminated
+	/**
+	 * @tag: name to identify a mount null terminated
 	 */
 	char *tag;
 
@@ -204,6 +208,7 @@  static int p9_virtio_cancelled(struct p9_client *client, struct p9_req_t *req)
  * this takes a list of pages.
  * @sg: scatter/gather list to pack into
  * @start: which segment of the sg_list to start at
+ * @limit: maximum number of pages in sg list.
  * @pdata: a list of pages to add into sg.
  * @nr_pages: number of pages to pack into the scatter/gather list
  * @offs: amount of data in the beginning of first page _not_ to pack