net: be more restrictive with ethernet address format

[dpdk.git] / lib / librte_net / rte_ether.h

diff --git a/lib/librte_net/rte_ether.h b/lib/librte_net/rte_ether.h
index 8a040ab..aa6eff0 100644 (file)
--- a/lib/librte_net/rte_ether.h
+++ b/lib/librte_net/rte_ether.h
@@ -252,6 +252,9 @@ rte_ether_format_addr(char *buf, uint16_t size,
  *
  * @param str
  *   A pointer to buffer contains the formatted MAC address.
+ *   The supported formats are:
+ *     XX:XX:XX:XX:XX:XX or XXXX:XXXX:XXXX
+ *   where XX is a hex digit: 0-9, a-f, or A-F.
  * @param eth_addr
  *   A pointer to a ether_addr structure.
  * @return