Document Linux peak RSS measurement limitation

This commit is contained in:
David Peter authored and David Peter committed 2026-10-06 13:25:36 +02:00
1 parent 7395dde05d
commit 3b64ea1bf5
1 file changed
+3 -1
+3 -1
View File
@@ -184,7 +184,9 @@ The JSON export includes the following metrics for each measured run (excluding
- Linux/macOS: Peak resident set size (RSS). This is the largest per-process peak among the - Linux/macOS: Peak resident set size (RSS). This is the largest per-process peak among the
command and child processes (whose usage is collected when their parents wait for them), command and child processes (whose usage is collected when their parents wait for them),
*not the simultaneous total memory of the full process tree*. *not the simultaneous total memory of the full process tree*. On Linux, measuring commands
with a very small peak RSS (below the peak inherited from hyperfine at startup, which can
be a few MiB) will currently result in that inherited value being reported instead.
- Windows: Currently not supported. - Windows: Currently not supported.
- **`cpu_cycles`**: CPU cycles consumed. - **`cpu_cycles`**: CPU cycles consumed.