From ed4c95c061b51f74057487c03c6a2ef3daadcab1 Mon Sep 17 00:00:00 2001
From: Ben Pfaff <blp@ovn.org>
Date: Wed, 20 Jul 2016 16:44:55 -0700
Subject: [PATCH] packets: Improve comment on eth_addr_from_string().

Signed-off-by: Ben Pfaff <blp@ovn.org>
Acked-by: Ryan Moats <rmoats@us.ibm.com>
---
 lib/packets.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lib/packets.c b/lib/packets.c
index d1e2a70ea..e4c29d509 100644
--- a/lib/packets.c
+++ b/lib/packets.c
@@ -140,6 +140,9 @@ eth_addr_is_reserved(const struct eth_addr ea)
     return false;
 }
 
+/* Attempts to parse 's' as an Ethernet address.  If successful, stores the
+ * address in 'ea' and returns true, otherwise zeros 'ea' and returns
+ * false.  */
 bool
 eth_addr_from_string(const char *s, struct eth_addr *ea)
 {