Update README guideline on benchmarks

haskell · Jun 27, 2020 · 29cf225 · 29cf225
1 parent 9e25b07
commit 29cf225
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -312,9 +312,11 @@ See the [tasty-rerun](https://hackage.haskell.org/package/tasty-rerun-1.1.17/doc
 
 If you are touching performance sensitive code, take the time to run a differential
 benchmark between HEAD and upstream using the benchHist script. The configuration in
-`bench/hist.yaml` is setup to do this by default with the command:
+`bench/hist.yaml` is setup to do this by default assuming upstream is
+`origin/master`. Run the benchmarks with `stack`:
 
-    stack build ghcide:benchHist && stack exec benchHist
+    export STACK_YAML=...
+    stack bench
 
 It should take around 15 minutes and the results will be stored in the `bench-hist` folder.
 To interpret the results, see the comments in the `bench/Hist/Main.hs` module.

diff --git a/bench/hist.yaml b/bench/hist.yaml
@@ -36,7 +36,7 @@ versions:
 # - v0.0.5
 # - v0.0.6
 # - v0.1.0
-- v0.2.0
+# - v0.2.0
 - upstream: origin/master
 - HEAD