Commit 65b6e42cdc5b6a1ce2ada31cc294d7e60b22bb43
Committed by
Linus Torvalds
Linus Torvalds
1 parent
073b86dacc
Exists in
master
and in
7 other branches
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>
Showing 4 changed files with 15 additions and 8 deletions Side-by-side Diff
Documentation/DocBook/kernel-api.tmpl
| ... | ... | @@ -231,8 +231,14 @@ |
| 231 | 231 | !Dnet/sunrpc/sunrpc_syms.c |
| 232 | 232 | --> |
| 233 | 233 | !Enet/sunrpc/xdr.c |
| 234 | -!Enet/sunrpc/svcsock.c | |
| 234 | +!Enet/sunrpc/svc_xprt.c | |
| 235 | +!Enet/sunrpc/xprt.c | |
| 235 | 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 | 242 | </sect1> |
| 237 | 243 | </chapter> |
| 238 | 244 |
net/sunrpc/clnt.c
| ... | ... | @@ -464,9 +464,9 @@ |
| 464 | 464 | |
| 465 | 465 | /** |
| 466 | 466 | * rpc_bind_new_program - bind a new RPC program to an existing client |
| 467 | - * @old - old rpc_client | |
| 468 | - * @program - rpc program to set | |
| 469 | - * @vers - rpc program version | |
| 467 | + * @old: old rpc_client | |
| 468 | + * @program: rpc program to set | |
| 469 | + * @vers: rpc program version | |
| 470 | 470 | * |
| 471 | 471 | * Clones the rpc client and sets up a new RPC program. This is mainly |
| 472 | 472 | * of use for enabling different RPC programs to share the same transport. |
| ... | ... | @@ -575,7 +575,7 @@ |
| 575 | 575 | * @clnt: pointer to RPC client |
| 576 | 576 | * @msg: RPC call parameters |
| 577 | 577 | * @flags: RPC call flags |
| 578 | - * @ops: RPC call ops | |
| 578 | + * @tk_ops: RPC call ops | |
| 579 | 579 | * @data: user call data |
| 580 | 580 | */ |
| 581 | 581 | int |
| ... | ... | @@ -610,7 +610,7 @@ |
| 610 | 610 | * rpc_peeraddr - extract remote peer address from clnt's xprt |
| 611 | 611 | * @clnt: RPC client structure |
| 612 | 612 | * @buf: target buffer |
| 613 | - * @size: length of target buffer | |
| 613 | + * @bufsize: length of target buffer | |
| 614 | 614 | * |
| 615 | 615 | * Returns the number of bytes that are actually in the stored address. |
| 616 | 616 | */ |
net/sunrpc/rpc_pipe.c
| ... | ... | @@ -677,7 +677,7 @@ |
| 677 | 677 | /** |
| 678 | 678 | * rpc_mkdir - Create a new directory in rpc_pipefs |
| 679 | 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 | 682 | * This creates a directory at the given @path associated with |
| 683 | 683 | * @rpc_clnt, which will contain a file named "info" with some basic |
| ... | ... | @@ -748,6 +748,7 @@ |
| 748 | 748 | * @private: private data to associate with the pipe, for the caller's use |
| 749 | 749 | * @ops: operations defining the behavior of the pipe: upcall, downcall, |
| 750 | 750 | * release_pipe, and destroy_msg. |
| 751 | + * @flags: rpc_inode flags | |
| 751 | 752 | * |
| 752 | 753 | * Data is made available for userspace to read by calls to |
| 753 | 754 | * rpc_queue_upcall(). The actual reads will result in calls to |
net/sunrpc/xprt.c