Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

net: 9p: Fix kerneldoc warnings of missing parameters etc

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>
Acked-by: Dominique Martinet <asmadeus@codewreck.org>
Link: https://lore.kernel.org/r/20201031182655.1082065-1-andrew@lunn.ch
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

authored by

Andrew Lunn and committed by
Jakub Kicinski
760b3d61 c43fd36f

+19 -6
+4 -2
net/9p/client.c
··· 412 412 413 413 /** 414 414 * p9_client_cb - call back from transport to client 415 - * c: client state 416 - * req: request received 415 + * @c: client state 416 + * @req: request received 417 + * @status: request status, one of REQ_STATUS_* 417 418 * 418 419 */ 419 420 void p9_client_cb(struct p9_client *c, struct p9_req_t *req, int status) ··· 556 555 * p9_check_zc_errors - check 9p packet for error return and process it 557 556 * @c: current client instance 558 557 * @req: request to parse and check for error conditions 558 + * @uidata: external buffer containing error 559 559 * @in_hdrlen: Size of response protocol buffer. 560 560 * 561 561 * returns error code if one is discovered, otherwise returns 0
+3 -1
net/9p/trans_common.c
··· 17 17 #include "trans_common.h" 18 18 19 19 /** 20 - * p9_release_pages - Release pages after the transaction. 20 + * p9_release_pages - Release pages after the transaction. 21 + * @pages: array of pages to be put 22 + * @nr_pages: size of array 21 23 */ 22 24 void p9_release_pages(struct page **pages, int nr_pages) 23 25 {
+3 -1
net/9p/trans_fd.c
··· 45 45 * @rfd: file descriptor for reading (trans=fd) 46 46 * @wfd: file descriptor for writing (trans=fd) 47 47 * @port: port to connect to (trans=tcp) 48 - * 48 + * @privport: port is privileged 49 49 */ 50 50 51 51 struct p9_fd_opts { ··· 95 95 * @err: error state 96 96 * @req_list: accounting for requests which have been sent 97 97 * @unsent_req_list: accounting for requests that haven't been sent 98 + * @rreq: read request 99 + * @wreq: write request 98 100 * @req: current request being processed (if any) 99 101 * @tmp_buf: temporary buffer to read in header 100 102 * @rc: temporary fcall for reading current frame
+2
net/9p/trans_rdma.c
··· 99 99 /** 100 100 * struct p9_rdma_context - Keeps track of in-process WR 101 101 * 102 + * @cqe: completion queue entry 102 103 * @busa: Bus address to unmap when the WR completes 103 104 * @req: Keeps track of requests (send) 104 105 * @rc: Keepts track of replies (receive) ··· 116 115 /** 117 116 * struct p9_rdma_opts - Collection of mount options 118 117 * @port: port of connection 118 + * @privport: Whether a privileged port may be used 119 119 * @sq_depth: The requested depth of the SQ. This really doesn't need 120 120 * to be any deeper than the number of threads used in the client 121 121 * @rq_depth: The depth of the RQ. Should be greater than or equal to SQ depth
+7 -2
net/9p/trans_virtio.c
··· 50 50 * @client: client instance 51 51 * @vdev: virtio dev associated with this channel 52 52 * @vq: virtio queue associated with this channel 53 + * @ring_bufs_avail: flag to indicate there is some available in the ring buf 54 + * @vc_wq: wait queue for waiting for thing to be added to ring buf 55 + * @p9_max_pages: maximum number of pinned pages 53 56 * @sg: scatter gather list which is used to pack a request (protected?) 57 + * @chan_list: linked list of channels 54 58 * 55 59 * We keep all per-channel information in a structure. 56 60 * This structure is allocated within the devices dev->mem space. ··· 78 74 unsigned long p9_max_pages; 79 75 /* Scatterlist: can be too big for stack. */ 80 76 struct scatterlist sg[VIRTQUEUE_NUM]; 81 - /* 82 - * tag name to identify a mount null terminated 77 + /** 78 + * @tag: name to identify a mount null terminated 83 79 */ 84 80 char *tag; 85 81 ··· 208 204 * this takes a list of pages. 209 205 * @sg: scatter/gather list to pack into 210 206 * @start: which segment of the sg_list to start at 207 + * @limit: maximum number of pages in sg list. 211 208 * @pdata: a list of pages to add into sg. 212 209 * @nr_pages: number of pages to pack into the scatter/gather list 213 210 * @offs: amount of data in the beginning of first page _not_ to pack