From: Julien Desfossez <julien.desfossez@efficios.com>
Date: Mon, 12 Mar 2012 16:00:00 +0000 (-0400)
Subject: bt_context_add_trace, bt_iter_pos and bt_iter needed some more comments.
X-Git-Tag: v1.0.0-pre4~4
X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=31265d844034f20986b37670beca678b81be0741

bt_context_add_trace, bt_iter_pos and bt_iter needed some more comments.

Fixes #75

Signed-off-by: Julien Desfossez <julien.desfossez@efficios.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/include/babeltrace/context.h b/include/babeltrace/context.h
index 4ad17971..591c9cad 100644
--- a/include/babeltrace/context.h
+++ b/include/babeltrace/context.h
@@ -45,17 +45,24 @@ struct bt_context *bt_context_create(void);
  *
  * Open a trace.
  *
- * packet_seek can be NULL to use the default packet_seek handler
- * provided by the trace format. If non-NULL, it is used as an override
- * of the handler for seeks across packets. It takes as parameter a
- * stream position, the packet index it needs to seek to (for SEEK_SET),
- * and a "whence" parameter (either SEEK_CUR: seek to next packet, or
- * SEEK_SET: seek to packet at packet index).
- *
- * If "path" is NULL, stream_list is used instread as a list of streams
- * to open for the trace.
-
- * The metadata parameter acts as a metadata override when not NULL.
+ * path is the path to the trace, it is not recursive. If "path" is NULL,
+ * stream_list is used instead as a list of mmap streams to open for the trace.
+ *
+ * format is a string containing the format name in which the trace was
+ * produced.
+ *
+ * packet_seek can be NULL to use the default packet_seek handler provided by
+ * the trace format. If non-NULL, it is used as an override of the handler for
+ * seeks across packets. It takes as parameter a stream position, the packet
+ * index it needs to seek to (for SEEK_SET), and a "whence" parameter (either
+ * SEEK_CUR: seek to next packet, or SEEK_SET: seek to packet at packet index).
+ *
+ * stream_list is a linked list of streams, it is used to open a trace where
+ * the trace data is located in memory mapped areas instead of trace files,
+ * this argument should be set to NULL when path is not NULL.
+ *
+ * The metadata parameter acts as a metadata override when not NULL, otherwise
+ * the format handles the metadata opening.
  *
  * Return: the trace handle id (>= 0) on success, a negative
  * value on error.
diff --git a/include/babeltrace/iterator.h b/include/babeltrace/iterator.h
index 94df03c8..1aaa5dd0 100644
--- a/include/babeltrace/iterator.h
+++ b/include/babeltrace/iterator.h
@@ -24,6 +24,23 @@
 struct bt_iter;
 struct bt_saved_pos;
 
+/*
+ * bt_iter is an abstract class, each format has to implement its own
+ * iterator derived from this parent class.
+ */
+
+/*
+ * bt_iter_pos
+ *
+ * This structure represents the position where to set an iterator.
+ *
+ * type represents the type of seek to use.
+ * u is the argument of the seek if necessary :
+ * - seek_time is the timestamp to seek to when using BT_SEEK_TIME, it
+ *   is expressed in "raw" seconds (not offsetted)
+ * - restore is a position saved with bt_iter_get_pos, it is used with
+ *   BT_SEEK_RESTORE.
+ */
 struct bt_iter_pos {
 	enum {
 		BT_SEEK_TIME,		/* uses u.seek_time */