3ae32c5 · streamly · git.iko.soy

git.iko.soy/streamly

on master help sign in

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

3ae32c5Adithya Kumar4 years ago

.packcheck.ignore−1

compare with master

unifiedsplit

@@ -9,7 +9,6 @@

9.packcheck.ignore

10appveyor.yml

11benchmark/bench-runner/default.nix

12−benchmark/bench-runner/cabal.project

13bin/ghc.sh

12bin/ghc.sh

14bin/run-ci.sh

13bin/run-ci.sh

15bin/run-repl-quick.sh

14bin/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

25time because it has to build the `bench-report` executable which has a

26lot of dependencies.

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:

30```

37```

31$ cd benchmark/bench-runner

38$ cd benchmark/bench-runner

32$ nix-shell --run 'cabal install bench-runner --installdir=../../ --overwrite-policy=always'

39$ nix-shell --run 'cabal install bench-runner --installdir=../../ --overwrite-policy=always'

33$ cd ../../

40$ cd ../../

41+$ ./bench-runner <bench-runner-args>

34```

42```

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:

37```

45```

38$ cabal run bench-runner --project-file=cabal.project.report -- <bench-runner-args>

46$ cabal run bench-runner --project-file=cabal.project.report -- <bench-runner-args>

39```

47```

41−## bench.sh: Quick start

49+## bench-runner: Quick start

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

44`cabal run bench-runner --project-file=cabal.project.report --`

52`cabal run bench-runner --project-file=cabal.project.report --`

46Useful commands:

54Useful commands: