ghcide/bench
Pepe Iborra baafe2cb82
Prepare for v0.6.0 release (#940)
* Prepare for v0.6.0 release

* Credit @mpardalos for the opentelemetry work
2020-12-09 08:35:09 +00:00
..
exe Allow to easily customise the example used for benchmarks (#838) 2020-09-29 07:47:09 +01:00
hist Extract the benchmarking Shake rules to a standalone Cabal package (#941) 2020-12-07 15:03:15 +00:00
lib Extract the benchmarking Shake rules to a standalone Cabal package (#941) 2020-12-07 15:03:15 +00:00
config.yaml Prepare for v0.6.0 release (#940) 2020-12-09 08:35:09 +00:00
README.md Allow to easily customise the example used for benchmarks (#838) 2020-09-29 07:47:09 +01:00

Benchmarks

This folder contains two Haskell programs that work together to simplify the performance analysis of ghcide:

  • exe/Main.hs - a standalone benchmark runner. Run with stack run ghcide-bench
  • hist/Main.hs - a Shake script for running the benchmark suite over a set of commits.
    • Run with stack bench or cabal bench,
    • Requires a ghcide-bench binary in the PATH (usually provided by stack/cabal),
    • Calls cabal (or stack, configurable) internally to build the project,
    • Driven by the config.yaml configuration file. By default it compares HEAD with "master"

Further details available in the config file and the module header comments.