tipc: improve naming and comment consistency in media layer

struct 'tipc_media' represents the specific info that the media
layer adaptors (eth_media and ib_media) expose to the generic
bearer layer. We clarify this by improved commenting, and by giving
the 'media_list' array the more appropriate name 'media_info_array'.

There are no functional changes in this commit.

Signed-off-by: Ying Xue <ying.xue@windriver.com>
Reviewed-by: Paul Gortmaker <paul.gortmaker@windriver.com>
Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

diff --git a/net/tipc/bearer.c b/net/tipc/bearer.c
index 826aa9fdf45fbf3c074ac688d024fbe6bcd0b28e..2411bac2b8f986df47be13cdc84ce0e7bf5fb07a 100644 (file)
--- a/net/tipc/bearer.c
+++ b/net/tipc/bearer.c
@@ -41,7 +41,7 @@
 
 #define MAX_ADDR_STR 60
 
-static struct tipc_media * const media_list[] = {
+static struct tipc_media * const media_info_array[] = {
        &eth_media_info,
 #ifdef CONFIG_TIPC_MEDIA_IB
        &ib_media_info,
@@ -60,11 +60,11 @@ struct tipc_media *tipc_media_find(const char *name)
 {
        u32 i;
 
-       for (i = 0; media_list[i] != NULL; i++) {
-               if (!strcmp(media_list[i]->name, name))
+       for (i = 0; media_info_array[i] != NULL; i++) {
+               if (!strcmp(media_info_array[i]->name, name))
                        break;
        }
-       return media_list[i];
+       return media_info_array[i];
 }
 
 /**
@@ -74,11 +74,11 @@ static struct tipc_media *media_find_id(u8 type)
 {
        u32 i;
 
-       for (i = 0; media_list[i] != NULL; i++) {
-               if (media_list[i]->type_id == type)
+       for (i = 0; media_info_array[i] != NULL; i++) {
+               if (media_info_array[i]->type_id == type)
                        break;
        }
-       return media_list[i];
+       return media_info_array[i];
 }
 
 /**
@@ -116,10 +116,10 @@ struct sk_buff *tipc_media_get_names(void)
        if (!buf)
                return NULL;
 
-       for (i = 0; media_list[i] != NULL; i++) {
+       for (i = 0; media_info_array[i] != NULL; i++) {
                tipc_cfg_append_tlv(buf, TIPC_TLV_MEDIA_NAME,
-                                   media_list[i]->name,
-                                   strlen(media_list[i]->name) + 1);
+                                   media_info_array[i]->name,
+                                   strlen(media_info_array[i]->name) + 1);
        }
        return buf;
 }
@@ -209,7 +209,7 @@ struct tipc_bearer *tipc_bearer_find_interface(const char *if_name)
 struct sk_buff *tipc_bearer_get_names(void)
 {
        struct sk_buff *buf;
-       struct tipc_bearer *b_ptr;
+       struct tipc_bearer *b;
        int i, j;
 
        buf = tipc_cfg_reply_alloc(MAX_BEARERS * TLV_SPACE(TIPC_MAX_BEARER_NAME));
@@ -217,13 +217,13 @@ struct sk_buff *tipc_bearer_get_names(void)
                return NULL;
 
        read_lock_bh(&tipc_net_lock);
-       for (i = 0; media_list[i] != NULL; i++) {
+       for (i = 0; media_info_array[i] != NULL; i++) {
                for (j = 0; j < MAX_BEARERS; j++) {
-                       b_ptr = &tipc_bearers[j];
-                       if (b_ptr->active && (b_ptr->media == media_list[i])) {
+                       b = &tipc_bearers[j];
+                       if (b->active && (b->media == media_info_array[i])) {
                                tipc_cfg_append_tlv(buf, TIPC_TLV_BEARER_NAME,
-                                                   b_ptr->name,
-                                                   strlen(b_ptr->name) + 1);
+                                                   b->name,
+                                                   strlen(b->name) + 1);
                        }
                }
        }

diff --git a/net/tipc/bearer.h b/net/tipc/bearer.h
index 516af8c0577ddf8538fbdb0930b246b13fdc4103..e50266aa4d1051163379edaca8a42a26e9ae034e 100644 (file)
--- a/net/tipc/bearer.h
+++ b/net/tipc/bearer.h
@@ -73,14 +73,13 @@ struct tipc_media_addr {
 struct tipc_bearer;
 
 /**
- * struct tipc_media - TIPC media information available to internal users
+ * struct tipc_media - Media specific info exposed to generic bearer layer
  * @send_msg: routine which handles buffer transmission
  * @enable_media: routine which enables a media
  * @disable_media: routine which disables a media
  * @addr2str: routine which converts media address to string
  * @addr2msg: routine which converts media address to protocol message area
  * @msg2addr: routine which converts media address from protocol message area
- * @bcast_addr: media address used in broadcasting
  * @priority: default link (and bearer) priority
  * @tolerance: default time (in ms) before declaring link failure
  * @window: default window (in packets) before declaring link congestion
@@ -105,13 +104,14 @@ struct tipc_media {
 };
 
 /**
- * struct tipc_bearer - TIPC bearer structure
+ * struct tipc_bearer - Generic TIPC bearer structure
  * @usr_handle: pointer to additional media-specific information about bearer
  * @mtu: max packet size bearer can support
  * @lock: spinlock for controlling access to bearer
  * @addr: media-specific address associated with bearer
  * @name: bearer name (format = media:interface)
  * @media: ptr to media structure associated with bearer
+ * @bcast_addr: media address used in broadcasting
  * @priority: default link priority for bearer
  * @window: default window size for bearer
  * @tolerance: default link tolerance for bearer