Commit bda14606 authored by Randy Dunlap's avatar Randy Dunlap Committed by Trond Myklebust
Browse files

sunrpc: fix kernel-doc warnings 



Fix kernel-doc warnings in sunrpc/rpc_pipe.c and
sunrpc/rpcb_clnt.c:

Warning(net/sunrpc/rpcb_clnt.c:428): No description found for parameter 'net'
Warning(net/sunrpc/rpcb_clnt.c:567): No description found for parameter 'net'

Warning(net/sunrpc/rpc_pipe.c:133): No description found for parameter 'pipe'
Warning(net/sunrpc/rpc_pipe.c:133): Excess function parameter 'inode' description in 'rpc_queue_upcall'
Warning(net/sunrpc/rpc_pipe.c:839): No description found for parameter 'pipe'
Warning(net/sunrpc/rpc_pipe.c:839): Excess function parameter 'ops' description in 'rpc_mkpipe_dentry'
Warning(net/sunrpc/rpc_pipe.c:839): Excess function parameter 'flags' description in 'rpc_mkpipe_dentry'
Warning(net/sunrpc/rpc_pipe.c:949): No description found for parameter 'dentry'
Warning(net/sunrpc/rpc_pipe.c:949): Excess function parameter 'clnt' description in 'rpc_remove_client_dir'

Signed-off-by: default avatarRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: default avatarTrond Myklebust <Trond.Myklebust@netapp.com>
parent 5abc03cd

net/sunrpc/rpc_pipe.c

+3 −5
Original line number Diff line number Diff line
@@ -120,7 +120,7 @@ EXPORT_SYMBOL_GPL(rpc_pipe_generic_upcall); 


/**

 * rpc_queue_upcall - queue an upcall message to userspace

 * @inode: inode of upcall pipe on which to queue given message

 * @pipe: upcall pipe on which to queue given message

 * @msg: message to queue

 *

 * Call with an @inode created by rpc_mkpipe() to queue an upcall.
@@ -819,9 +819,7 @@ static int rpc_rmdir_depopulate(struct dentry *dentry, 
 * @parent: dentry of directory to create new "pipe" in

 * @name: name of pipe

 * @private: private data to associate with the pipe, for the caller's use

 * @ops: operations defining the behavior of the pipe: upcall, downcall,

 *	release_pipe, open_pipe, and destroy_msg.

 * @flags: rpc_pipe flags

 * @pipe: &rpc_pipe containing input parameters

 *

 * Data is made available for userspace to read by calls to

 * rpc_queue_upcall().  The actual reads will result in calls to
@@ -943,7 +941,7 @@ struct dentry *rpc_create_client_dir(struct dentry *dentry, 


/**

 * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()

 * @clnt: rpc client

 * @dentry: dentry for the pipe

 */

int rpc_remove_client_dir(struct dentry *dentry)

{

net/sunrpc/rpcb_clnt.c

+2 −0
Original line number Diff line number Diff line
@@ -394,6 +394,7 @@ static int rpcb_register_call(struct rpc_clnt *clnt, struct rpc_message *msg) 


/**

 * rpcb_register - set or unset a port registration with the local rpcbind svc

 * @net: target network namespace

 * @prog: RPC program number to bind

 * @vers: RPC version number to bind

 * @prot: transport protocol to register
@@ -521,6 +522,7 @@ static int rpcb_unregister_all_protofamilies(struct sunrpc_net *sn, 


/**

 * rpcb_v4_register - set or unset a port registration with the local rpcbind

 * @net: target network namespace

 * @program: RPC program number of service to (un)register

 * @version: RPC version number of service to (un)register

 * @address: address family, IP address, and port to (un)register

CRA Git | Maintained and supported by SUSTech CRA and CCSE