Build: don't enable Bisect by default

Resolves #138.
ocaml · May 8, 2018 · 94f9f5a · 94f9f5a
1 parent 27a1480
commit 94f9f5a
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 8 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -164,7 +164,10 @@ The intended response to this is:
 The odoc repo is set up for coverage analysis. This is most useful if you're
 writing new tests, and want to know what they are actually touching. To use it,
 
-1. Run `make coverage`. This will run the tests as normal, except at the end you
+1. Run `make clean` once, before beginning to work with coverage. This rebuilds
+   odoc with Bisect_ppx linked in.
+
+2. Run `make coverage`. This will run the tests as normal, except at the end you
    will get a message like
 
     ```
@@ -177,9 +180,9 @@ writing new tests, and want to know what they are actually touching. To use it,
    "accidentally" by tests that are checking other properties, however, in which
    case coverage analysis will not be very useful :)
 
-2. Write new tests.
+3. Write new tests.
 
-3. Check coverage again.
+4. Check coverage again.
 
 <br/>
 

diff --git a/Makefile b/Makefile
@@ -19,8 +19,10 @@ BISECT_FILES_PATTERN := _build/default/test/*/bisect*.out
 .PHONY : coverage
 coverage :
 	find . -name 'bisect*.out' | xargs rm -f
-	jbuilder build @test/parser/runtest --dev --no-buffer -j 1 --force
-	jbuilder build @test/html/runtest --dev --no-buffer -j 1 --force
+	BISECT_ENABLE=yes \
+	  jbuilder build @test/parser/runtest --dev --no-buffer -j 1 --force
+	BISECT_ENABLE=yes \
+	  jbuilder build @test/html/runtest --dev --no-buffer -j 1 --force
 	@bisect-ppx-report \
 	    -I _build/default/ -html $(COVERAGE)/ \
 	    -text - -summary-only \

diff --git a/odoc.opam b/odoc.opam
@@ -27,7 +27,7 @@ depends: [
   # Development dependencies. These should be removed in opam files sent to the
   # opam repo.
   "alcotest" {>= "0.8.3"}
-  "bisect_ppx"
+  "bisect_ppx"  {>= "1.3.0"}
   "lambdasoup"
   "ocamlfind"
   "sexplib"

diff --git a/src/html/jbuild b/src/html/jbuild
@@ -2,5 +2,5 @@
 
 (library
  ((name html)
-  (preprocess (pps (bisect_ppx)))
+  (preprocess (pps (bisect_ppx -conditional)))
   (libraries (model tyxml))))
diff --git a/src/parser/jbuild b/src/parser/jbuild
@@ -4,5 +4,5 @@
 
 (library
  ((name parser_)
-  (preprocess (pps (bisect_ppx)))
+  (preprocess (pps (bisect_ppx -conditional)))
   (libraries (model astring))))