[PATCH] sunrpc: fix missing kernel-doc

[PATCH] sunrpc: fix missing kernel-doc

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

Fix sunrpc kernel-doc warnings:

Warning(net/sunrpc/clnt.c:629): No description found for parameter 'req'
Warning(net/sunrpc/clnt.c:629): No description found for parameter 'tk_ops'
Warning(net/sunrpc/clnt.c:629): Excess function parameter 'ops' description in 'rpc_run_bc_task'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 net/sunrpc/clnt.c |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-2.6.30-git22.orig/net/sunrpc/clnt.c
+++ linux-2.6.30-git22/net/sunrpc/clnt.c
@@ -622,7 +622,8 @@ EXPORT_SYMBOL_GPL(rpc_call_async);
 /**
  * rpc_run_bc_task - Allocate a new RPC task for backchannel use, then run
  * rpc_execute against it
- * @ops: RPC call ops
+ * @req: the RPC request
+ * @tk_ops: RPC call ops
  */
 struct rpc_task *rpc_run_bc_task(struct rpc_rqst *req,
 					const struct rpc_call_ops *tk_ops)



-- 
~Randy
LPC 2009, Sept. 23-25, Portland, Oregon
http://linuxplumbersconf.org/2009/

[PATCH] sunrpc: fix missing kernel-doc

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

Fix missing sunrpc kernel-doc:

Warning(linux-2.6.25-git7//net/sunrpc/xprt.c:451): No description found for parameter 'action'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 net/sunrpc/xprt.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-2.6.25-git7.orig/net/sunrpc/xprt.c
+++ linux-2.6.25-git7/net/sunrpc/xprt.c
@@ -445,7 +445,7 @@ EXPORT_SYMBOL_GPL(xprt_wake_pending_task
 /**
  * xprt_wait_for_buffer_space - wait for transport output buffer to clear
  * @task: task to be put to sleep
- *
+ * @action: function pointer to be executed after wait
  */
 void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action)
 {

Re: [PATCH] sunrpc: fix missing kernel-doc

[David Miller]

From: Randy Dunlap <randy.dunlap@oracle.com>
Date: Fri, 25 Apr 2008 08:57:50 -0700

> Fix missing sunrpc kernel-doc:
> 
> Warning(linux-2.6.25-git7//net/sunrpc/xprt.c:451): No description found for parameter 'action'
> 
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>

Applied, thanks a lot Randy.