Commit 760b3d61 authored by Andrew Lunn's avatar Andrew Lunn Committed by Jakub Kicinski
Browse files

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: default avatarAndrew Lunn <andrew@lunn.ch>
Acked-by: default avatarDominique Martinet <asmadeus@codewreck.org>
Link: https://lore.kernel.org/r/20201031182655.1082065-1-andrew@lunn.ch


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent c43fd36f

net/9p/client.c

+4 −2
Original line number Diff line number Diff line
@@ -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 @@ out_err: 
 * 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

net/9p/trans_common.c

+3 −1
Original line number Diff line number Diff line
@@ -18,6 +18,8 @@ 


/**

 * 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)

{

net/9p/trans_fd.c

+3 −1
Original line number Diff line number Diff line
@@ -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

net/9p/trans_rdma.c

+2 −0
Original line number Diff line number Diff line
@@ -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

net/9p/trans_virtio.c

+7 −2
Original line number Diff line number Diff line
@@ -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

CRA Git | Maintained and supported by SUSTech CRA and CCSE