From d73a75418933959309f080c4ad95b8c18a8f5a39 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Fri, 19 Jan 2024 10:02:49 -0500 Subject: [PATCH] doc --- src/fuchsia/trace_fuchsia.mli | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/fuchsia/trace_fuchsia.mli b/src/fuchsia/trace_fuchsia.mli index b08620a..a104ec3 100644 --- a/src/fuchsia/trace_fuchsia.mli +++ b/src/fuchsia/trace_fuchsia.mli @@ -1,3 +1,11 @@ +(** Fuchsia trace collector. + + This provides a collector for traces that emits data into a file + using the compact binary + {{:https://fuchsia.dev/fuchsia-src/reference/tracing/trace-format} Fuchsia trace format}. + This reduces the tracing overhead compared to [trace-tef], at the expense of simplicity. +*) + val collector : out:[ `File of string | `Stderr | `Stdout ] -> unit -> Trace_core.collector (** Make a collector that writes into the given output. @@ -34,7 +42,6 @@ val setup : ?out:[ output | `Env ] -> unit -> unit val with_setup : ?out:[ output | `Env ] -> unit -> (unit -> 'a) -> 'a (** [with_setup () f] (optionally) sets a collector up, calls [f()], and makes sure to shutdown before exiting. - since 0.2 a () argument was added. *) (**/**)