on master help sign in
Remove cabal.project in bench-runner and update the benchmark guide
commit3ae32c55d919a19578c2de22d35e7ae5f7c40af6 authorAdithya Kumar <adithya@composewell.com> dateWed 10 Aug 2022, 11:16 (4 years ago) parente304abc
3 files changed+13−7
.packcheck.ignore−1 benchmark/bench-runner/cabal.project−1 docs/Developer/Benchmarks.md+13−5
.packcheck.ignore−1
@@ -9,7 +9,6 @@
99.packcheck.ignore
1010appveyor.yml
1111benchmark/bench-runner/default.nix
12−benchmark/bench-runner/cabal.project
1312bin/ghc.sh
1413bin/run-ci.sh
1514bin/run-repl-quick.sh
benchmark/bench-runner/cabal.projectdeleted−1
@@ -1 +0,0 @@
1−packages: ., ../../targets
docs/Developer/Benchmarks.md+13−5
@@ -25,22 +25,30 @@ IMPORTANT NOTE: The first time you run this executable it may take a long
2525time because it has to build the `bench-report` executable which has a
2626lot of dependencies.
2727
28−If you are using nix then use `benchmark/bench-runner/default.nix`. Build it
29−manually and install it in the root of the repository like so,
28+You can install it once in the root of the repository and use it multiple times.
29+
30+You can use `cabal.project.report` to install bench-runner like so:
31+```
32+$ cabal install bench-runner --project-file=cabal.project.report --installdir=./ --overwrite-policy=always
33+$ ./bench-runner <bench-runner-args>
34+```
35+
36+If you're using nix, you can install bench-runner like so:
3037```
3138$ cd benchmark/bench-runner
3239$ nix-shell --run 'cabal install bench-runner --installdir=../../ --overwrite-policy=always'
3340$ cd ../../
41+$ ./bench-runner <bench-runner-args>
3442```
3543
36−You can also use `cabal.project.report` to directly build an run the `bench-runner` like so,
44+You can run the `bench-runner` without installing, like so:
3745```
3846$ cabal run bench-runner --project-file=cabal.project.report -- <bench-runner-args>
3947```
4048
41−## bench.sh: Quick start
49+## bench-runner: Quick start
4250
43−Assuming `bench-runner` is the executable. You can replace `bench-runner` with
51+Assuming `bench-runner` is the executable. You can replace `./bench-runner` with
4452`cabal run bench-runner --project-file=cabal.project.report --`
4553
4654Useful commands: