tipc: Update commenting in TIPC API

Eliminate comments in TIPC's main API files that are either obsolete,
incorrect, misleading, or unhelpful.  It also adds in one new comment.

Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
Signed-off-by: Paul Gortmaker <paul.gortmaker@windriver.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

diff --git a/include/linux/tipc.h b/include/linux/tipc.h
index 9536d8aeadf17db62c4a906face8258bc2500125..181c8d0e6f739fbfd091876c0726206491b8b1cd 100644 (file)
--- a/include/linux/tipc.h
+++ b/include/linux/tipc.h
@@ -107,7 +107,7 @@ static inline unsigned int tipc_node(__u32 addr)
  * Message importance levels
  */
 
-#define TIPC_LOW_IMPORTANCE            0  /* default */
+#define TIPC_LOW_IMPORTANCE            0
 #define TIPC_MEDIUM_IMPORTANCE         1
 #define TIPC_HIGH_IMPORTANCE           2
 #define TIPC_CRITICAL_IMPORTANCE       3
@@ -182,7 +182,7 @@ struct sockaddr_tipc {
                struct tipc_name_seq nameseq;
                struct {
                        struct tipc_name name;
-                       __u32 domain; /* 0: own zone */
+                       __u32 domain;
                } name;
        } addr;
 };
@@ -200,7 +200,7 @@ struct sockaddr_tipc {
  */
 
 #define TIPC_IMPORTANCE                127     /* Default: TIPC_LOW_IMPORTANCE */
-#define TIPC_SRC_DROPPABLE     128     /* Default: 0 (resend congested msg) */
+#define TIPC_SRC_DROPPABLE     128     /* Default: based on socket type */
 #define TIPC_DEST_DROPPABLE    129     /* Default: based on socket type */
 #define TIPC_CONN_TIMEOUT      130     /* Default: 8000 (ms)  */
 #define TIPC_NODE_RECVQ_DEPTH  131     /* Default: none (read only) */

diff --git a/include/net/tipc/tipc.h b/include/net/tipc/tipc.h
index 9566608c88cf88878ea742dfa9451d1e7a146ae4..15af6dca0b493f982f6de117402a19f04c7b03a1 100644 (file)
--- a/include/net/tipc/tipc.h
+++ b/include/net/tipc/tipc.h
@@ -2,7 +2,7 @@
  * include/net/tipc/tipc.h: Main include file for TIPC users
  * 
  * Copyright (c) 2003-2006, Ericsson AB
- * Copyright (c) 2005, Wind River Systems
+ * Copyright (c) 2005,2010 Wind River Systems
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -126,7 +126,7 @@ int tipc_createport(unsigned int tipc_user,
                    tipc_msg_event message_cb, 
                    tipc_named_msg_event named_message_cb, 
                    tipc_conn_msg_event conn_message_cb, 
-                   tipc_continue_event continue_event_cb,/* May be zero */
+                   tipc_continue_event continue_event_cb,
                    u32 *portref);
 
 int tipc_deleteport(u32 portref);
@@ -145,13 +145,13 @@ int tipc_set_portunreturnable(u32 portref, unsigned int isunreturnable);
 int tipc_publish(u32 portref, unsigned int scope, 
                 struct tipc_name_seq const *name_seq);
 int tipc_withdraw(u32 portref, unsigned int scope,
-                 struct tipc_name_seq const *name_seq); /* 0: all */
+                 struct tipc_name_seq const *name_seq);
 
 int tipc_connect2port(u32 portref, struct tipc_portid const *port);
 
 int tipc_disconnect(u32 portref);
 
-int tipc_shutdown(u32 ref); /* Sends SHUTDOWN msg */
+int tipc_shutdown(u32 ref);
 
 int tipc_isconnected(u32 portref, int *isconnected);
 
@@ -176,7 +176,7 @@ int tipc_send_buf(u32 portref,
 
 int tipc_send2name(u32 portref, 
                   struct tipc_name const *name, 
-                  u32 domain,  /* 0:own zone */
+                  u32 domain,
                   unsigned int num_sect,
                   struct iovec const *msg_sect);
 
@@ -188,7 +188,7 @@ int tipc_send_buf2name(u32 portref,
 
 int tipc_forward2name(u32 portref, 
                      struct tipc_name const *name, 
-                     u32 domain,   /*0: own zone */
+                     u32 domain,
                      unsigned int section_count,
                      struct iovec const *msg_sect,
                      struct tipc_portid const *origin,
@@ -228,14 +228,14 @@ int tipc_forward_buf2port(u32 portref,
 
 int tipc_multicast(u32 portref, 
                   struct tipc_name_seq const *seq, 
-                  u32 domain,  /* 0:own zone */
+                  u32 domain,  /* currently unused */
                   unsigned int section_count,
                   struct iovec const *msg);
 
 #if 0
 int tipc_multicast_buf(u32 portref, 
                       struct tipc_name_seq const *seq, 
-                      u32 domain,      /* 0:own zone */
+                      u32 domain,
                       void *buf,
                       unsigned int size);
 #endif