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 <[email protected]>
subashd · May 1, 2012 · 33f1ff8 · 33f1ff8
1 parent 1ea9e60
commit 33f1ff8
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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'.