From 2f5d314fe2dd003583aec6ec11ba9425f8abdcba Mon Sep 17 00:00:00 2001 From: Mathieu Desnoyers Date: Fri, 17 Feb 2012 14:53:16 -0500 Subject: [PATCH] fix: context.h add missing documentation for packet_seek parameter Signed-off-by: Mathieu Desnoyers --- include/babeltrace/context.h | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/include/babeltrace/context.h b/include/babeltrace/context.h index f9da534e..ba42dbd0 100644 --- 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. -- 2.34.1