cfm: Clarify cfm_create() documentation.

[sliver-openvswitch.git] / lib / cfm.c

diff --git a/lib/cfm.c b/lib/cfm.c
index b6239c3..a605c09 100644 (file)
--- a/lib/cfm.c
+++ b/lib/cfm.c
@@ -129,8 +129,9 @@ lookup_remote_mp(const struct hmap *hmap, uint16_t mpid)
 }
 
 /* Allocates a 'cfm' object.  This object should have its 'mpid', 'maid',
- * 'eth_src', and 'interval' filled out.  When changes are made to the 'cfm'
- * object, cfm_configure should be called before using it. */
+ * 'eth_src', and 'interval' filled out.  cfm_configure() should be called
+ * whenever changes are made to 'cfm', and before cfm_run() is called for the
+ * first time. */
 struct cfm *
 cfm_create(void)
 {