From 6f3b487f35b34c3f42b00a2588d50e7468c4016f Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Tue, 20 Jan 2026 20:31:27 -0500 Subject: [PATCH] bit of doc --- src/core/trace_core.mli | 6 +++++- src/debug/track_spans.mli | 2 ++ src/tef/trace_tef.mli | 8 ++++++++ src/trace.ml | 6 ++++++ 4 files changed, 21 insertions(+), 1 deletion(-) diff --git a/src/core/trace_core.mli b/src/core/trace_core.mli index 81102f3..3c936fd 100644 --- a/src/core/trace_core.mli +++ b/src/core/trace_core.mli @@ -1,4 +1,8 @@ -(** Trace. *) +(** Main tracing interface. + + This interface is intended to be lightweight and usable in both libraries + and applications. It has very low overhead if no {!Collector.t} is + installed. *) include module type of Types module Collector = Collector diff --git a/src/debug/track_spans.mli b/src/debug/track_spans.mli index aa3d088..2282c5f 100644 --- a/src/debug/track_spans.mli +++ b/src/debug/track_spans.mli @@ -1,3 +1,5 @@ +(** Helper to track which spans never get closed. *) + open Trace_core type unclosed_spans = { diff --git a/src/tef/trace_tef.mli b/src/tef/trace_tef.mli index b796d52..a8ab0ab 100644 --- a/src/tef/trace_tef.mli +++ b/src/tef/trace_tef.mli @@ -1,3 +1,11 @@ +(** TEF collector for Trace. + + This emits chrome traces + (https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/), + which are very simple and a known quantity. + + They can be opened in https://ui.perfetto.dev . *) + module Collector_tef = Collector_tef module Exporter = Exporter module Writer = Writer diff --git a/src/trace.ml b/src/trace.ml index 5684517..477d8ae 100644 --- a/src/trace.ml +++ b/src/trace.ml @@ -1 +1,7 @@ +(** Shim that just forwards to {!Trace_core}. + + The reason is, [Trace] is already defined in the compiler libs and can clash + with this module inside a toplevel. So it's safer to only depend on + [Trace_core] in libraries that might end up used in a toplevel. *) + include Trace_core