Skip to content

Commit ae40d4c

Browse files
committed
Document the timeline
1 parent 72882ce commit ae40d4c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

AGENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@
1818
- Additionally `--enable dump:rival` outputs all Rival commands it
1919
executes, which can be useful for debugging Rival &
2020
arbitrary-precision code.
21+
22+
# Timeline
23+
24+
- The timeline is Herbie's observability tooling. Timeline information
25+
goes into `timeline.json` and `timeline.html`.
26+
- A timeline is a list of phases, each of which is a hash table from
27+
key to "table", where a table is a list of rows each of which is a
28+
fixed-length array. Define new timeline types in
29+
`src/utils/timeline.rkt` and add/change HTML generation in
30+
`src/reports/timeline.rkt`.
31+
- Add to the timeline with `(timeline-push! 'type val1 val2 ...)`. The
32+
`val`s must be JSON-compatible; this mostly means you have to
33+
convert symbols to strings.
2134

2235
# Documentation
2336

0 commit comments

Comments
 (0)