Skip to content

Commit

Permalink
report adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
PragTob committed Dec 22, 2023
1 parent 21845bf commit 54b7c9b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -539,8 +539,8 @@ Benchee can store the results of previous runs in a file and then load them agai
**Saving** is done through the `:save` configuration option. You can specify a `:path` where results are saved, or you can use the default option of`"benchmark.benchee"` if you don't pass a `:path`. You can also pass a `:tag` option which annotates these results (for instance with a branch name or elixir version number). The default option for the `:tag` is a timestamp of when the benchmark was run.

**Loading** is done through the `:load` option specifying a path to the file to load (for instance `"benchmark.benchee"`). You can also specify multiple files to load through a list of paths (`["my.benchee", "main_save.benchee"]`) - each one of those can also be a glob expression to match even more files glob (`"save_number*.benchee"`).
If all you want to do is to use `:load` without running any benchmarks then you can use `Benchee.report/1` which will take a normal configuration with a `:load` key and just format the loaded saved results with the given formatters.
In the more verbose API loading is triggered via `Benchee.load/1`.
If all you want to do is to use `:load` without running any benchmarks then you can use `Benchee.report/1` which will take a normal configuration with a `:load` key and just format the loaded saved results with the given formatters.

```elixir
Benchee.run(
Expand Down
3 changes: 2 additions & 1 deletion lib/benchee.ex
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ for {module, moduledoc} <- [{Benchee, elixir_doc}, {:benchee, erlang_doc}] do
that data missing (aka not running benchmarks, only running relative statistics).
You can use config options as normal, but some options related to benchmarking won't take
effect (such as `:time`).
effect (such as `:time`). The `:load` option however is mandatory to use, as you need to
load some benchmarks to report on them.
## Usage
Expand Down

0 comments on commit 54b7c9b

Please sign in to comment.