fix: context.h add missing documentation for packet_seek parameter

[babeltrace.git] / include / babeltrace / context.h

diff --git a/include/babeltrace/context.h b/include/babeltrace/context.h
index f9da534e66fd428572b1caba78b954e92c5a09a8..ba42dbd036b3ac9b78b36c819d4407dac8a2aba4 100644 (file)
--- a/include/babeltrace/context.h
+++ b/include/babeltrace/context.h
@@ -42,8 +42,14 @@ struct bt_context *bt_context_create(void);
 /*
  * bt_context_add_trace : Add a trace by path to the context
  *
- * Open a trace. Parameter packet_seek can be NULL to use the default
- * packet_seek handle of the format.
+ * 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).
  *
  * Return: the trace handle id (>= 0) on success, a negative
  * value on error.