Skip to content

Commit 5b8d7fa

Browse files
authored
Add a note on differential benchmarks (#647)
1 parent 8de10e9 commit 5b8d7fa

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

Diff for: README.md

+9
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,15 @@ If you are chasing down test failures, you can use the tasty-rerun feature by ru
310310
This writes a log file called `.tasty-rerun-log` of the failures, and only runs those.
311311
See the [tasty-rerun](https://hackage.haskell.org/package/tasty-rerun-1.1.17/docs/Test-Tasty-Ingredients-Rerun.html) documentation for other options.
312312

313+
If you are touching performance sensitive code, take the time to run a differential
314+
benchmark between HEAD and upstream using the benchHist script. The configuration in
315+
`bench/hist.yaml` is setup to do this by default with the command:
316+
317+
stack build ghcide:benchHist && stack exec benchHist
318+
319+
It should take around 15 minutes and the results will be stored in the `bench-hist` folder.
320+
To interpret the results, see the comments in the `bench/Hist/Main.hs` module.
321+
313322
### Building the extension
314323

315324
For development, you can also the VSCode extension from this repository (see

0 commit comments

Comments
 (0)