9p: minor comment fixes
Fix the comments -- mostly the improper and/or missing descriptions of function parameters. Signed-off-by: Abhishek Kulkarni <adkulkar@umail.iu.edu> Signed-off-by: Eric Van Hensbergen <ericvh@gmail.com>
This commit is contained in:
parent
2bb541157f
commit
0e15597ebf
|
@ -171,7 +171,6 @@ int v9fs_uflags2omode(int uflags, int extended)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* v9fs_blank_wstat - helper function to setup a 9P stat structure
|
* v9fs_blank_wstat - helper function to setup a 9P stat structure
|
||||||
* @v9ses: 9P session info (for determining extended mode)
|
|
||||||
* @wstat: structure to initialize
|
* @wstat: structure to initialize
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -410,9 +409,9 @@ v9fs_open_created(struct inode *inode, struct file *file)
|
||||||
* @v9ses: session information
|
* @v9ses: session information
|
||||||
* @dir: directory that dentry is being created in
|
* @dir: directory that dentry is being created in
|
||||||
* @dentry: dentry that is being created
|
* @dentry: dentry that is being created
|
||||||
|
* @extension: 9p2000.u extension string to support devices, etc.
|
||||||
* @perm: create permissions
|
* @perm: create permissions
|
||||||
* @mode: open mode
|
* @mode: open mode
|
||||||
* @extension: 9p2000.u extension string to support devices, etc.
|
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
static struct p9_fid *
|
static struct p9_fid *
|
||||||
|
|
|
@ -60,9 +60,9 @@ static struct p9_req_t *
|
||||||
p9_client_rpc(struct p9_client *c, int8_t type, const char *fmt, ...);
|
p9_client_rpc(struct p9_client *c, int8_t type, const char *fmt, ...);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* v9fs_parse_options - parse mount options into session structure
|
* parse_options - parse mount options into client structure
|
||||||
* @options: options string passed from mount
|
* @opts: options string passed from mount
|
||||||
* @v9ses: existing v9fs session information
|
* @clnt: existing v9fs client information
|
||||||
*
|
*
|
||||||
* Return 0 upon success, -ERRNO upon failure
|
* Return 0 upon success, -ERRNO upon failure
|
||||||
*/
|
*/
|
||||||
|
@ -232,7 +232,7 @@ EXPORT_SYMBOL(p9_tag_lookup);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* p9_tag_init - setup tags structure and contents
|
* p9_tag_init - setup tags structure and contents
|
||||||
* @tags: tags structure from the client struct
|
* @c: v9fs client struct
|
||||||
*
|
*
|
||||||
* This initializes the tags structure for each client instance.
|
* This initializes the tags structure for each client instance.
|
||||||
*
|
*
|
||||||
|
@ -258,7 +258,7 @@ error:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* p9_tag_cleanup - cleans up tags structure and reclaims resources
|
* p9_tag_cleanup - cleans up tags structure and reclaims resources
|
||||||
* @tags: tags structure from the client struct
|
* @c: v9fs client struct
|
||||||
*
|
*
|
||||||
* This frees resources associated with the tags structure
|
* This frees resources associated with the tags structure
|
||||||
*
|
*
|
||||||
|
@ -430,8 +430,8 @@ static int p9_check_errors(struct p9_client *c, struct p9_req_t *req)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* p9_client_flush - flush (cancel) a request
|
* p9_client_flush - flush (cancel) a request
|
||||||
* c: client state
|
* @c: client state
|
||||||
* req: request to cancel
|
* @oldreq: request to cancel
|
||||||
*
|
*
|
||||||
* This sents a flush for a particular requests and links
|
* This sents a flush for a particular requests and links
|
||||||
* the flush request to the original request. The current
|
* the flush request to the original request. The current
|
||||||
|
|
|
@ -119,8 +119,8 @@ struct p9_poll_wait {
|
||||||
* @wpos: write position for current frame
|
* @wpos: write position for current frame
|
||||||
* @wsize: amount of data to write for current frame
|
* @wsize: amount of data to write for current frame
|
||||||
* @wbuf: current write buffer
|
* @wbuf: current write buffer
|
||||||
|
* @poll_pending_link: pending links to be polled per conn
|
||||||
* @poll_wait: array of wait_q's for various worker threads
|
* @poll_wait: array of wait_q's for various worker threads
|
||||||
* @poll_waddr: ????
|
|
||||||
* @pt: poll state
|
* @pt: poll state
|
||||||
* @rq: current read work
|
* @rq: current read work
|
||||||
* @wq: current write work
|
* @wq: current write work
|
||||||
|
@ -700,9 +700,9 @@ static int p9_fd_cancel(struct p9_client *client, struct p9_req_t *req)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* parse_options - parse mount options into session structure
|
* parse_opts - parse mount options into p9_fd_opts structure
|
||||||
* @options: options string passed from mount
|
* @params: options string passed from mount
|
||||||
* @opts: transport-specific structure to parse options into
|
* @opts: fd transport-specific structure to parse options into
|
||||||
*
|
*
|
||||||
* Returns 0 upon success, -ERRNO upon failure
|
* Returns 0 upon success, -ERRNO upon failure
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -67,14 +67,15 @@
|
||||||
* @pd: Protection Domain pointer
|
* @pd: Protection Domain pointer
|
||||||
* @qp: Queue Pair pointer
|
* @qp: Queue Pair pointer
|
||||||
* @cq: Completion Queue pointer
|
* @cq: Completion Queue pointer
|
||||||
|
* @dm_mr: DMA Memory Region pointer
|
||||||
* @lkey: The local access only memory region key
|
* @lkey: The local access only memory region key
|
||||||
* @timeout: Number of uSecs to wait for connection management events
|
* @timeout: Number of uSecs to wait for connection management events
|
||||||
* @sq_depth: The depth of the Send Queue
|
* @sq_depth: The depth of the Send Queue
|
||||||
* @sq_sem: Semaphore for the SQ
|
* @sq_sem: Semaphore for the SQ
|
||||||
* @rq_depth: The depth of the Receive Queue.
|
* @rq_depth: The depth of the Receive Queue.
|
||||||
|
* @rq_count: Count of requests in the Receive Queue.
|
||||||
* @addr: The remote peer's address
|
* @addr: The remote peer's address
|
||||||
* @req_lock: Protects the active request list
|
* @req_lock: Protects the active request list
|
||||||
* @send_wait: Wait list when the SQ fills up
|
|
||||||
* @cm_done: Completion event for connection management tracking
|
* @cm_done: Completion event for connection management tracking
|
||||||
*/
|
*/
|
||||||
struct p9_trans_rdma {
|
struct p9_trans_rdma {
|
||||||
|
@ -154,9 +155,9 @@ static match_table_t tokens = {
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* parse_options - parse mount options into session structure
|
* parse_opts - parse mount options into rdma options structure
|
||||||
* @options: options string passed from mount
|
* @params: options string passed from mount
|
||||||
* @opts: transport-specific structure to parse options into
|
* @opts: rdma transport-specific structure to parse options into
|
||||||
*
|
*
|
||||||
* Returns 0 upon success, -ERRNO upon failure
|
* Returns 0 upon success, -ERRNO upon failure
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -57,11 +57,9 @@ static int chan_index;
|
||||||
* @initialized: whether the channel is initialized
|
* @initialized: whether the channel is initialized
|
||||||
* @inuse: whether the channel is in use
|
* @inuse: whether the channel is in use
|
||||||
* @lock: protects multiple elements within this structure
|
* @lock: protects multiple elements within this structure
|
||||||
|
* @client: client instance
|
||||||
* @vdev: virtio dev associated with this channel
|
* @vdev: virtio dev associated with this channel
|
||||||
* @vq: virtio queue associated with this channel
|
* @vq: virtio queue associated with this channel
|
||||||
* @tagpool: accounting for tag ids (and request slots)
|
|
||||||
* @reqs: array of request slots
|
|
||||||
* @max_tag: current number of request_slots allocated
|
|
||||||
* @sg: scatter gather list which is used to pack a request (protected?)
|
* @sg: scatter gather list which is used to pack a request (protected?)
|
||||||
*
|
*
|
||||||
* We keep all per-channel information in a structure.
|
* We keep all per-channel information in a structure.
|
||||||
|
@ -92,7 +90,7 @@ static unsigned int rest_of_page(void *data)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* p9_virtio_close - reclaim resources of a channel
|
* p9_virtio_close - reclaim resources of a channel
|
||||||
* @trans: transport state
|
* @client: client instance
|
||||||
*
|
*
|
||||||
* This reclaims a channel by freeing its resources and
|
* This reclaims a channel by freeing its resources and
|
||||||
* reseting its inuse flag.
|
* reseting its inuse flag.
|
||||||
|
@ -181,9 +179,8 @@ static int p9_virtio_cancel(struct p9_client *client, struct p9_req_t *req)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* p9_virtio_request - issue a request
|
* p9_virtio_request - issue a request
|
||||||
* @t: transport state
|
* @client: client instance issuing the request
|
||||||
* @tc: &p9_fcall request to transmit
|
* @req: request to be issued
|
||||||
* @rc: &p9_fcall to put reponse into
|
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue