Skip to content

Commit

Permalink
benchmark: review comments
Browse files Browse the repository at this point in the history
- Make multiple runs of benchmark actually run.
- Fix non-existent driver-benchmarks.json by adopting a simpler
  approach: instead of outputing in a file, then promoting, then running
  `cat`, we just output in the standard output.

Signed-off-by: Paul-Elliot <[email protected]>
  • Loading branch information
panglesd committed Sep 29, 2023
1 parent 12d9624 commit 8794f54
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 12 deletions.
7 changes: 1 addition & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,9 @@ publish-docs:
test :
dune runtest

# Echo is disabled as the benchmarks results are printed on stdout.
# '@bench' exit status is not checked as it's very likely to fail due to
# needing promotion rather than because it really failed.
.PHONY : bench
bench:
-@dune build @bench
@dune promote driver-benchmarks.json
@cat driver-benchmarks.json
@dune build @bench

.PHONY : coverage
coverage :
Expand Down
7 changes: 2 additions & 5 deletions doc/dune
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,12 @@
(> %{ocaml_version} 4.11))
(deps
(package odoc)
(universe) ; Benchmark depends on the running programs in the background
(glob_files *.mld)
(glob_files library_mlds/*)
(glob_files examples/*.ml*))
(action
(progn
; Make sure the benchmark result is created as Dune would not show the diff
; if the script failed before creating it.
(write-file driver-benchmarks.json "")
(run ocaml-mdx-test --force-output %{dep:driver.mld}))))
(run ocaml-mdx-test --force-output %{dep:driver.mld})))

(rule
(alias docgen)
Expand Down
2 changes: 1 addition & 1 deletion dune
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@
(rule
(alias bench)
(action
(diff driver-benchmarks.json doc/driver-benchmarks.json)))
(cat doc/driver-benchmarks.json)))

0 comments on commit 8794f54

Please sign in to comment.