From 79391eaa0d7fae433a26a3324a9f860172cf6e70 Mon Sep 17 00:00:00 2001 From: David Peter Date: Tue, 6 Oct 2026 09:34:46 +0200 Subject: [PATCH] Revise breaking changes in CHANGELOG Updated breaking changes section to clarify command execution and JSON export format. --- CHANGELOG.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e2e7382..a5ce7af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Breaking changes +- Benchmarked commands are now always executed directly, without an intermediate shell (`--shell=none`). Use `-S` (an alias for `--shell=default`) to restore the previous behavior (`sh` on Unix, `cmd.exe` on Windows), or select a shell with `--shell `. - The JSON format for `--export-json` has changed (schema version 2). The new format now includes metadata, per-run measurements, and statistical summaries for all measured quantities, see #790 (@sharkdp). Code that reads those exported JSON files must be updated. For example, `results[i].mean` is now `results[i].summary.time_wall_clock.mean`, and `results[i].times` is replaced by `results[i].measurements[j].time_wall_clock.value`. The new structure looks like this: ```python @@ -44,10 +45,7 @@ } ``` - Times are exported in seconds and memory in bytes, regardless of `--time-unit`. Unavailable memory metrics are omitted; `stddev` is `null` for a single measurement. Reference benchmarks additionally include `"is_reference": true`. - -- Execute commands directly by default (`--shell=none`). Use `-S` (an alias for `--shell=default`) to restore the previous behavior (`sh` on Unix, `cmd.exe` on Windows), or select a shell with `--shell `. -- Repurpose `-S` as an alias for `--shell=default`. It no longer accepts a shell argument; replace `-S ` with `--shell `. + Times are always exported in seconds and memory in bytes. # v1.21.0