[PATCH net-next] tipc: correct structure parameter comments for topsrv

[PATCH net-next] tipc: correct structure parameter comments for topsrv

[Zhenbo Gao]

Remove the following obsolete parameter comments of tipc_topsrv struct:
  @rcvbuf_cache
  @tipc_conn_new
  @tipc_conn_release
  @tipc_conn_recvmsg
  @imp
  @type

Add the comments for the missing parameters below of tipc_topsrv struct:
  @awork
  @listener

Remove the unused or duplicated parameter comments of tipc_conn struct:
  @outqueue_lock
  @rx_action

Signed-off-by: Zhenbo Gao <zhenbo.gao@windriver.com>
Reviewed-by: Ying Xue <ying.xue@windriver.com>
---
 net/tipc/topsrv.c | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)

diff --git a/net/tipc/topsrv.c b/net/tipc/topsrv.c
index c8e34ef..c782b35 100644
--- a/net/tipc/topsrv.c
+++ b/net/tipc/topsrv.c
@@ -57,16 +57,12 @@
  * @idr_lock: protect the connection identifier set
  * @idr_in_use: amount of allocated identifier entry
  * @net: network namspace instance
- * @rcvbuf_cache: memory cache of server receive buffer
+ * @awork: accept work item
  * @rcv_wq: receive workqueue
  * @send_wq: send workqueue
  * @max_rcvbuf_size: maximum permitted receive message length
- * @tipc_conn_new: callback will be called when new connection is incoming
- * @tipc_conn_release: callback will be called before releasing the connection
- * @tipc_conn_recvmsg: callback will be called when message arrives
+ * @listener: topsrv listener socket
  * @name: server name
- * @imp: message importance
- * @type: socket type
  */
 struct tipc_topsrv {
 	struct idr conn_idr;
@@ -90,9 +86,7 @@ struct tipc_topsrv {
  * @server: pointer to connected server
  * @sub_list: lsit to all pertaing subscriptions
  * @sub_lock: lock protecting the subscription list
- * @outqueue_lock: control access to the outqueue
  * @rwork: receive work item
- * @rx_action: what to do when connection socket is active
  * @outqueue: pointer to first outbound message in queue
  * @outqueue_lock: control access to the outqueue
  * @swork: send work item
-- 
1.9.1


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot

Re: [PATCH net-next] tipc: correct structure parameter comments for topsrv

[David Miller]

From: Zhenbo Gao <zhenbo.gao@windriver.com>
Date: Mon, 3 Sep 2018 14:08:40 +0800

> Remove the following obsolete parameter comments of tipc_topsrv struct:
>   @rcvbuf_cache
>   @tipc_conn_new
>   @tipc_conn_release
>   @tipc_conn_recvmsg
>   @imp
>   @type
> 
> Add the comments for the missing parameters below of tipc_topsrv struct:
>   @awork
>   @listener
> 
> Remove the unused or duplicated parameter comments of tipc_conn struct:
>   @outqueue_lock
>   @rx_action
> 
> Signed-off-by: Zhenbo Gao <zhenbo.gao@windriver.com>
> Reviewed-by: Ying Xue <ying.xue@windriver.com>

Applied, thank you.