[ovs-dev] [PATCH 4/4] ovs-numa: Add module description.

[Alex Wang]

Add a short description of the module and its assumption.

Signed-off-by: Alex Wang <alexw at nicira.com>
---
 lib/ovs-numa.c |   12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/lib/ovs-numa.c b/lib/ovs-numa.c
index 4698967..c909d5a 100644
--- a/lib/ovs-numa.c
+++ b/lib/ovs-numa.c
@@ -36,6 +36,18 @@
 
 VLOG_DEFINE_THIS_MODULE(ovs_numa);
 
+/* ovs-numa module
+ * ===============
+ *
+ * This module stores the affinity information of numa nodes and cpu cores.
+ * It also provides functions to bookkeep the pin of threads on cpu cores.
+ *
+ * It is assumed that the numa node ids and cpu core ids all start from 0 and
+ * range continuously.  So, for example, if 'ovs_numa_get_n_cores()' returns N,
+ * user can assume core ids from 0 to N-1 are all valid and there is a
+ * 'struct cpu_core' for each id.
+ */
+
 #define MAX_NUMA_NODES 128
 
 /* numa node. */
-- 
1.7.9.5