composewell/streamly
1
1
Fork 0
mirror of https://github.com/composewell/streamly.git synced 2024-08-16 06:50:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Remove cabal.project in bench-runner and update the benchmark guide

Browse Source
This commit is contained in:
Adithya Kumar 2022-08-10 11:16:53 +05:30
parent e304abc3cf
commit 3ae32c55d9
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.packcheck.ignore
View File

@ -9,7 +9,6 @@
.packcheck.ignore
appveyor.yml
benchmark/bench-runner/default.nix
benchmark/bench-runner/cabal.project
bin/ghc.sh
bin/run-ci.sh
bin/run-repl-quick.sh

1
benchmark/bench-runner/cabal.project
View File

@ -1 +0,0 @@
packages: ., ../../targets

18
docs/Developer/Benchmarks.md
View File

@ -25,22 +25,30 @@ IMPORTANT NOTE: The first time you run this executable it may take a long
time because it has to build the `bench-report` executable which has a
lot of dependencies.
If you are using nix then use `benchmark/bench-runner/default.nix`. Build it
manually and install it in the root of the repository like so,
You can install it once in the root of the repository and use it multiple times.
You can use `cabal.project.report` to install bench-runner like so:
```
$ cabal install bench-runner --project-file=cabal.project.report --installdir=./ --overwrite-policy=always
$ ./bench-runner <bench-runner-args>
```
If you're using nix, you can install bench-runner like so:
```
$ cd benchmark/bench-runner
$ nix-shell --run 'cabal install bench-runner --installdir=../../ --overwrite-policy=always'
$ cd ../../
$ ./bench-runner <bench-runner-args>
```
You can also use `cabal.project.report` to directly build an run the `bench-runner` like so,
You can run the `bench-runner` without installing, like so:
```
$ cabal run bench-runner --project-file=cabal.project.report -- <bench-runner-args>
```
## bench.sh: Quick start
## bench-runner: Quick start
Assuming `bench-runner` is the executable. You can replace `bench-runner` with
Assuming `bench-runner` is the executable. You can replace `./bench-runner` with
`cabal run bench-runner --project-file=cabal.project.report --`
Useful commands: