aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRandy Dunlap <randy.dunlap@oracle.com>2008-02-13 18:03:23 -0500
committerLinus Torvalds <torvalds@woody.linux-foundation.org>2008-02-13 19:21:19 -0500
commit65b6e42cdc5b6a1ce2ada31cc294d7e60b22bb43 (patch)
treef8e1629ab3dce44de715e29811020892d467b189
parent073b86dacc3c0fa79c71f3519169ea18d5521227 (diff)
docbook: sunrpc filenames and notation fixes
Use updated file list for docbook files and fix kernel-doc warnings in sunrpc: Warning(linux-2.6.24-git12//net/sunrpc/rpc_pipe.c:689): No description found for parameter 'rpc_client' Warning(linux-2.6.24-git12//net/sunrpc/rpc_pipe.c:765): No description found for parameter 'flags' Warning(linux-2.6.24-git12//net/sunrpc/clnt.c:584): No description found for parameter 'tk_ops' Warning(linux-2.6.24-git12//net/sunrpc/clnt.c:618): No description found for parameter 'bufsize' Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Cc: Trond Myklebust <trond.myklebust@fys.uio.no> Cc: "J. Bruce Fields" <bfields@fieldses.org> Cc: Neil Brown <neilb@suse.de> Cc: "David S. Miller" <davem@davemloft.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
-rw-r--r--Documentation/DocBook/kernel-api.tmpl8
-rw-r--r--net/sunrpc/clnt.c10
-rw-r--r--net/sunrpc/rpc_pipe.c3
-rw-r--r--net/sunrpc/xprt.c2
4 files changed, 15 insertions, 8 deletions
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
index 75e4ed15ab9a..6c0e5f018615 100644
--- a/Documentation/DocBook/kernel-api.tmpl
+++ b/Documentation/DocBook/kernel-api.tmpl
@@ -231,8 +231,14 @@ X!Ilib/string.c
231!Dnet/sunrpc/sunrpc_syms.c 231!Dnet/sunrpc/sunrpc_syms.c
232--> 232-->
233!Enet/sunrpc/xdr.c 233!Enet/sunrpc/xdr.c
234!Enet/sunrpc/svcsock.c 234!Enet/sunrpc/svc_xprt.c
235!Enet/sunrpc/xprt.c
235!Enet/sunrpc/sched.c 236!Enet/sunrpc/sched.c
237!Enet/sunrpc/socklib.c
238!Enet/sunrpc/stats.c
239!Enet/sunrpc/rpc_pipe.c
240!Enet/sunrpc/rpcb_clnt.c
241!Enet/sunrpc/clnt.c
236 </sect1> 242 </sect1>
237 </chapter> 243 </chapter>
238 244
diff --git a/net/sunrpc/clnt.c b/net/sunrpc/clnt.c
index 0998e6d09664..8c6a7f1a25e9 100644
--- a/net/sunrpc/clnt.c
+++ b/net/sunrpc/clnt.c
@@ -464,9 +464,9 @@ rpc_release_client(struct rpc_clnt *clnt)
464 464
465/** 465/**
466 * rpc_bind_new_program - bind a new RPC program to an existing client 466 * rpc_bind_new_program - bind a new RPC program to an existing client
467 * @old - old rpc_client 467 * @old: old rpc_client
468 * @program - rpc program to set 468 * @program: rpc program to set
469 * @vers - rpc program version 469 * @vers: rpc program version
470 * 470 *
471 * Clones the rpc client and sets up a new RPC program. This is mainly 471 * Clones the rpc client and sets up a new RPC program. This is mainly
472 * of use for enabling different RPC programs to share the same transport. 472 * of use for enabling different RPC programs to share the same transport.
@@ -575,7 +575,7 @@ EXPORT_SYMBOL_GPL(rpc_call_sync);
575 * @clnt: pointer to RPC client 575 * @clnt: pointer to RPC client
576 * @msg: RPC call parameters 576 * @msg: RPC call parameters
577 * @flags: RPC call flags 577 * @flags: RPC call flags
578 * @ops: RPC call ops 578 * @tk_ops: RPC call ops
579 * @data: user call data 579 * @data: user call data
580 */ 580 */
581int 581int
@@ -610,7 +610,7 @@ EXPORT_SYMBOL_GPL(rpc_call_start);
610 * rpc_peeraddr - extract remote peer address from clnt's xprt 610 * rpc_peeraddr - extract remote peer address from clnt's xprt
611 * @clnt: RPC client structure 611 * @clnt: RPC client structure
612 * @buf: target buffer 612 * @buf: target buffer
613 * @size: length of target buffer 613 * @bufsize: length of target buffer
614 * 614 *
615 * Returns the number of bytes that are actually in the stored address. 615 * Returns the number of bytes that are actually in the stored address.
616 */ 616 */
diff --git a/net/sunrpc/rpc_pipe.c b/net/sunrpc/rpc_pipe.c
index 7e197168a245..0e3ead7e11b9 100644
--- a/net/sunrpc/rpc_pipe.c
+++ b/net/sunrpc/rpc_pipe.c
@@ -677,7 +677,7 @@ rpc_lookup_negative(char *path, struct nameidata *nd)
677/** 677/**
678 * rpc_mkdir - Create a new directory in rpc_pipefs 678 * rpc_mkdir - Create a new directory in rpc_pipefs
679 * @path: path from the rpc_pipefs root to the new directory 679 * @path: path from the rpc_pipefs root to the new directory
680 * @rpc_clnt: rpc client to associate with this directory 680 * @rpc_client: rpc client to associate with this directory
681 * 681 *
682 * This creates a directory at the given @path associated with 682 * This creates a directory at the given @path associated with
683 * @rpc_clnt, which will contain a file named "info" with some basic 683 * @rpc_clnt, which will contain a file named "info" with some basic
@@ -748,6 +748,7 @@ rpc_rmdir(struct dentry *dentry)
748 * @private: private data to associate with the pipe, for the caller's use 748 * @private: private data to associate with the pipe, for the caller's use
749 * @ops: operations defining the behavior of the pipe: upcall, downcall, 749 * @ops: operations defining the behavior of the pipe: upcall, downcall,
750 * release_pipe, and destroy_msg. 750 * release_pipe, and destroy_msg.
751 * @flags: rpc_inode flags
751 * 752 *
752 * Data is made available for userspace to read by calls to 753 * Data is made available for userspace to read by calls to
753 * rpc_queue_upcall(). The actual reads will result in calls to 754 * rpc_queue_upcall(). The actual reads will result in calls to
diff --git a/net/sunrpc/xprt.c b/net/sunrpc/xprt.c
index cfcade906a56..d5553b8179f9 100644
--- a/net/sunrpc/xprt.c
+++ b/net/sunrpc/xprt.c
@@ -124,7 +124,7 @@ EXPORT_SYMBOL_GPL(xprt_register_transport);
124 124
125/** 125/**
126 * xprt_unregister_transport - unregister a transport implementation 126 * xprt_unregister_transport - unregister a transport implementation
127 * transport: transport to unregister 127 * @transport: transport to unregister
128 * 128 *
129 * Returns: 129 * Returns:
130 * 0: transport successfully unregistered 130 * 0: transport successfully unregistered