From: Ben Pfaff <blp@nicira.com>
Date: Mon, 30 Apr 2012 18:23:38 +0000 (-0700)
Subject: netdev: Document use for get_etheraddr member of struct netdev_class.
X-Git-Tag: sliver-openvswitch-1.8.90-0~48^2~496
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=33f1ff8464641c392fb713fe4e45be0c18a6b047;p=sliver-openvswitch.git

netdev: Document use for get_etheraddr member of struct netdev_class.

This has confused developers adding hardware support, e.g.:
http://openvswitch.org/pipermail/dev/2012-April/016350.html

Signed-off-by: Ben Pfaff <blp@nicira.com>
---

diff --git a/lib/netdev-provider.h b/lib/netdev-provider.h
index daf46adee..6daae5e6c 100644
--- a/lib/netdev-provider.h
+++ b/lib/netdev-provider.h
@@ -231,7 +231,10 @@ struct netdev_class {
     /* Sets 'netdev''s Ethernet address to 'mac' */
     int (*set_etheraddr)(struct netdev *netdev, const uint8_t mac[6]);
 
-    /* Retrieves 'netdev''s Ethernet address into 'mac'. */
+    /* Retrieves 'netdev''s Ethernet address into 'mac'.
+     *
+     * This address will be advertised as 'netdev''s MAC address through the
+     * OpenFlow protocol, among other uses. */
     int (*get_etheraddr)(const struct netdev *netdev, uint8_t mac[6]);
 
     /* Retrieves 'netdev''s MTU into '*mtup'.