X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Fcontext.h;h=591c9cad029757951dc642d1631d9914fd8ef22a;hp=4ad1797134e890e82b66e531e165f696f61286b6;hb=31265d844034f20986b37670beca678b81be0741;hpb=04ae3991741c634481fc3fa069664ae28bbdbaa6

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.