Skip to content

Commit

Permalink
Update benchmark README
Browse files Browse the repository at this point in the history
  • Loading branch information
SRv6d committed Oct 6, 2024
1 parent 609637a commit b551c3f
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/benchmark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ With the exception of [RIPE-NCC/whois], the AS3257 object is included as a strin
## Running Benchmarks

Benchmarks for the parser itself are done using `cargo bench`, while any external parser is benchmarked using [hyperfine].\
To run specific benchmarks, execute `/.run` in the directory of the respective parser.
It sets up dependencies and runs `sudo` so it is only recommended to be used in an isolated environment and is only tested using the devcontainer, other platforms might require additional dependencies to be installed.
To run a specific benchmark execute `just bench-$PARSER-NAME` or `just benchmark-comparison` to run all benchmarks. This will setup required dependencies and run `sudo` so it is only recommended to be used in an isolated environment and is only tested using the devcontainer, other platforms might require additional dependencies to be installed. A working installation of `just` and `cargo` is assumed.

[RPSL::Parser]: https://metacpan.org/pod/RPSL::Parser
[irrdnet/irrd]: https://github.com/irrdnet/irrd
Expand Down

0 comments on commit b551c3f

Please sign in to comment.