1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
.PHONY : build
build :
dune build -p markup,markup-lwt
# This is not part of the ordinary build process. The output file, entities.ml,
# is checked into git.
.PHONY : entities
entities :
dune exec src/translate_entities/translate_entities.exe \
> src/entities.ml
.PHONY : test
test :
dune runtest
.PHONY : coverage
coverage :
find . -name '*.coverage' | xargs rm -f
dune runtest --instrument-with bisect_ppx --force
bisect-ppx-report html --expect src/ --do-not-expect src/translate_entities/
bisect-ppx-report summary
@echo See _coverage/index.html
.PHONY : performance-test
performance-test :
dune exec test/performance/performance_markup.exe
dune exec test/performance/performance_nethtml.exe
dune exec test/performance/performance_xmlm.exe
.PHONY : js-test
js-test :
dune build test/js_of_ocaml/test_js_of_ocaml.bc.js
.PHONY : dependency-test
dependency-test :
dune exec test/dependency/dep_core.exe
dune exec test/dependency/dep_lwt.exe
dune exec test/dependency/dep_lwt_unix.exe
# Everything from here to "clean" is inactive, pending porting to odoc.
OCAML_VERSION := \
$(shell ocamlc -version | grep -E -o '^[0-9]+\.[0-9]+' | sed 's/\.//')
OCAMLBUILD := ocamlbuild -use-ocamlfind -j 0 -no-links
HTML := docs/html
DOCFLAGS := -docflags -colorize-code
if_package = ! ocamlfind query $(1) > /dev/null 2> /dev/null || ( $(2) )
.PHONY : docs
docs : docs-odocl
$(OCAMLBUILD) $(DOCFLAGS) doc/$(LIB).docdir/index.html
rm -rf $(HTML)
mkdir -p $(HTML)
rsync -r _build/doc/$(LIB).docdir/* $(HTML)/
cp doc/style.css $(HTML)/
$(call if_package,lambdasoup,\
test $(OCAML_VERSION) -eq 402 \
|| ( make docs-postprocess \
&& rm -f $(HTML)/type_*.html $(HTML)/html.stamp $(HTML)/index*.html \
&& _build/doc/postprocess.native ))
@echo "\nSee $(HTML)/index.html"
.PHONY : docs-postprocess
docs-postprocess :
$(OCAMLBUILD) postprocess.native
ODOCL := doc/markup.odocl
.PHONY : docs-odocl
docs-odocl :
echo Markup > $(ODOCL)
$(call if_package,lwt,echo Markup_lwt >> $(ODOCL))
$(call if_package,lwt.unix,echo Markup_lwt_unix >> $(ODOCL))
PUBLISH := docs/publish
.PHONY : publish-docs
publish-docs : check-doc-prereqs docs
rm -rf $(PUBLISH)
mkdir -p $(PUBLISH)
cd $(PUBLISH) \
&& git init \
&& git remote add github git@github.com:aantron/markup.ml.git \
&& rsync -r ../html/* ./ \
&& git add -A \
&& git commit -m 'Markup.ml documentation.' \
&& git push -uf github master:gh-pages
DOC_ZIP := docs/$(LIB)-$(VERSION)-doc.zip
.PHONY : package-docs
package-docs : check-doc-prereqs docs
rm -f $(DOC_ZIP)
zip -9 $(DOC_ZIP) $(HTML)/*
.PHONY : check-doc-prereqs
check-doc-prereqs :
@ocamlfind query lwt.unix > /dev/null 2> /dev/null \
|| (echo "\nLwt not installed" && false)
@ocamlfind query lambdasoup > /dev/null 2> /dev/null \
|| (echo "\nLambda Soup not installed" && false)
.PHONY : clean
clean :
rm -rf $(HTML) $(PUBLISH) $(DOC_ZIP)
dune clean
rm -rf _coverage
|
