From 498b2a5a68dcfea734f42ba548b7c61aabd8385b Mon Sep 17 00:00:00 2001
From: Ethan Jackson <ethan@nicira.com>
Date: Fri, 13 May 2011 12:52:00 -0700
Subject: [PATCH] cfm: Clarify cfm_create() documentation.
Reported-by: Ben Pfaff <blp@nicira.com>
---
lib/cfm.c | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/lib/cfm.c b/lib/cfm.c
index b6239c30a..a605c098e 100644
--- 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)
{
--
2.47.0