citrun

commit 0852142d0a40ec2b4975fd72fd1e90a73570ef68
parent 268d9711542f33504ac3127965e1099cf70b260f
Author: Kyle Milz <kyle@0x30.net>
Date:   Sun, 22 Jan 2017 11:06:10 -0700

lib: try and improve comment

Diffstat:
M
lib.c
 | 
9
++++++---

1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/lib.c b/lib.c
@@ -41,10 +41,13 @@ citrun_add_header()
 }
 
 /*
- * Public Interface.
+ * Public Interface citrun_node_add.
  *
- * Copies n into the shared memory file and then points n->data to a region of
- * memory located right after n that's at least 8 * n->size large.
+ * Create or enlarge memory block backed by file. The first call to this
+ * function creates a new memory block with a header.
+ * Any call after the first enlarges the memory block with enough storage for:
+ * - copying incoming struct citrun_node verbatim
+ * - live execution buffers (8 bytes per line of instrumented translation unit)
  * Exits on failure.
  */
 void