SUNRPC: Fix some kernel doc complaints
authorChuck Lever <chuck.lever@oracle.com>
Wed, 19 Dec 2018 16:00:22 +0000 (11:00 -0500)
committerAnna Schumaker <Anna.Schumaker@Netapp.com>
Wed, 2 Jan 2019 17:05:18 +0000 (12:05 -0500)
Clean up some warnings observed when building with "make W=1".

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
Signed-off-by: Anna Schumaker <Anna.Schumaker@Netapp.com>
net/sunrpc/auth_gss/gss_mech_switch.c
net/sunrpc/backchannel_rqst.c
net/sunrpc/xprtmultipath.c
net/sunrpc/xprtsock.c

index 16ac0f4cb7d8e1ebae658c29234778ee7678aabf..379318dff5347325365d5a3ecc436c339f9817fe 100644 (file)
@@ -244,7 +244,7 @@ gss_mech_get_by_pseudoflavor(u32 pseudoflavor)
 
 /**
  * gss_mech_list_pseudoflavors - Discover registered GSS pseudoflavors
- * @array: array to fill in
+ * @array_ptr: array to fill in
  * @size: size of "array"
  *
  * Returns the number of array items filled in, or a negative errno.
index fa5ba6ed3197a8be56bb401109759941ac0618b0..ec451b8114b0b07dbe5db102af8002d58b7804cd 100644 (file)
@@ -197,7 +197,7 @@ out_free:
 /**
  * xprt_destroy_backchannel - Destroys the backchannel preallocated structures.
  * @xprt:      the transport holding the preallocated strucures
- * @max_reqs   the maximum number of preallocated structures to destroy
+ * @max_reqs:  the maximum number of preallocated structures to destroy
  *
  * Since these structures may have been allocated by multiple calls
  * to xprt_setup_backchannel, we only destroy up to the maximum number
index e2d64c7138c3aedb40febb75a6f2936345e3cb11..8394124126f8f2cabb73387f5a8c871dab5bbf20 100644 (file)
@@ -383,7 +383,7 @@ void xprt_iter_init_listall(struct rpc_xprt_iter *xpi,
 /**
  * xprt_iter_xchg_switch - Atomically swap out the rpc_xprt_switch
  * @xpi: pointer to rpc_xprt_iter
- * @xps: pointer to a new rpc_xprt_switch or NULL
+ * @newswitch: pointer to a new rpc_xprt_switch or NULL
  *
  * Swaps out the existing xpi->xpi_xpswitch with a new value.
  */
@@ -401,7 +401,7 @@ struct rpc_xprt_switch *xprt_iter_xchg_switch(struct rpc_xprt_iter *xpi,
 
 /**
  * xprt_iter_destroy - Destroys the xprt iterator
- * @xpi pointer to rpc_xprt_iter
+ * @xpi: pointer to rpc_xprt_iter
  */
 void xprt_iter_destroy(struct rpc_xprt_iter *xpi)
 {
index a6870d3cb1216891958be4569ce10204eaa06454..bd64d5a776a3ac4a5dab724951874810c90f18ca 100644 (file)
@@ -1596,6 +1596,7 @@ static void xs_udp_set_buffer_size(struct rpc_xprt *xprt, size_t sndsize, size_t
 
 /**
  * xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
+ * @xprt: controlling transport
  * @task: task that timed out
  *
  * Adjust the congestion window after a retransmit timeout has occurred.
@@ -2253,6 +2254,7 @@ out:
 
 /**
  * xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
+ * @work: queued work item
  *
  * Invoked by a work queue tasklet.
  */