Skip to content

Commit ac08379

Browse files
committed
Mention runner_map's double duty in the README.
1 parent 489dca8 commit ac08379

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,13 @@ In `bench_runner.toml`, the `flag_effect_plot` table has a `subplots` key which
172172
- `version`: The version series to compare. Should be a 2-part version, e.g. "3.14"
173173
- `head_flags`: A list of flags to use as the head.
174174
- `base_flags`: (optional) A list of flags to use as the base. By default, this is a default build, i.e. no flags.
175-
- `runner_map`: (optional) If you need to map a runner to a base in a different runner, you can provide that mapping here. For example, with tail-calling, you may want to compare runners configured to use clang against runners configured with the "default compiler" for a given platform. The mapping is from the "head" runner nickname to the "base" runner nickname.
175+
- `runner_map`: (optional) If you need to map a runner to a base in a
176+
different runner, you can provide that mapping here. For example, with
177+
tail-calling, you may want to compare runners configured to use clang
178+
against runners configured with the "default compiler" for a given
179+
platform. The mapping is from the "head" runner nickname to the "base"
180+
runner nickname. If runner_map is not empty, only the "head" runners in
181+
the map are plotted.
176182

177183
For example:
178184

0 commit comments

Comments
 (0)