Commit acf0a39f authored Dec 19, 2018 by Chuck Lever Committed by Anna Schumaker Jan 02, 2019

SUNRPC: Fix some kernel doc complaints



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>

parent dc5820bd

net/sunrpc/auth_gss/gss_mech_switch.c

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -244,7 +244,7 @@ gss_mech_get_by_pseudoflavor(u32 pseudoflavor)

	/**		/**
	* gss_mech_list_pseudoflavors - Discover registered GSS pseudoflavors		* gss_mech_list_pseudoflavors - Discover registered GSS pseudoflavors
	* @array: array to fill in		* @array_ptr: array to fill in
	* @size: size of "array"		* @size: size of "array"
	*		*
	* Returns the number of array items filled in, or a negative errno.		* Returns the number of array items filled in, or a negative errno.

net/sunrpc/backchannel_rqst.c

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -197,7 +197,7 @@ int xprt_setup_bc(struct rpc_xprt *xprt, unsigned int min_reqs)
	/**		/**
	* xprt_destroy_backchannel - Destroys the backchannel preallocated structures.		* xprt_destroy_backchannel - Destroys the backchannel preallocated structures.
	* @xprt: the transport holding the preallocated strucures		* @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		* Since these structures may have been allocated by multiple calls
	* to xprt_setup_backchannel, we only destroy up to the maximum number		* to xprt_setup_backchannel, we only destroy up to the maximum number

net/sunrpc/xprtmultipath.c

+2 −2

Original line number	Original line	Diff line number	Diff line
	@@ -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		* xprt_iter_xchg_switch - Atomically swap out the rpc_xprt_switch
	* @xpi: pointer to rpc_xprt_iter		* @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.		* 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		* 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)		void xprt_iter_destroy(struct rpc_xprt_iter *xpi)
	{		{

net/sunrpc/xprtsock.c

+2 −0

Original line number	Original line	Diff line number	Diff line
	@@ -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		* xs_udp_timer - called when a retransmit timeout occurs on a UDP transport
			* @xprt: controlling transport
	* @task: task that timed out		* @task: task that timed out
	*		*
	* Adjust the congestion window after a retransmit timeout has occurred.		* Adjust the congestion window after a retransmit timeout has occurred.
	@@ -2253,6 +2254,7 @@ static int xs_tcp_finish_connecting(struct rpc_xprt xprt, struct socket sock)

	/**		/**
	* xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint		* xs_tcp_setup_socket - create a TCP socket and connect to a remote endpoint
			* @work: queued work item
	*		*
	* Invoked by a work queue tasklet.		* Invoked by a work queue tasklet.
	*/		*/