forked from simonmichael/hledger
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile.old
1344 lines (1133 loc) · 39.3 KB
/
Makefile.old
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
###############################################################################
# Old hledger project makefile, kept for reference. See Makefile instead.
# import def-help* functions for documenting make rules. See the file for usage.
include help-system.mk
default: help \
$(call def-help,help,\
list all documented rules in this makefile\
)
###############################################################################
# VARS
# GHC-compiled executables require a locale (and not just C) or they
# will die on encountering non-ascii data. Set LANG to something if not already set.
export LANG?=en_US.UTF-8
# command to run during "make prof" and "make heap"
PROFCMD=bin/hledger-prof balance -f data/1000x1000x10.journal >/dev/null
#PROFRTSFLAGS=-p
PROFRTSFLAGS=-P
# command to run during "make coverage"
COVCMD=test
COVCMD=-f test-wf.csv print
# executables to run during "make simplebench"
BENCHEXES=hledger-0.23.3 hledger
# misc. tools
BROWSE=open
VIEWHTML=$(BROWSE)
VIEWPS=$(BROWSE)
VIEWPDF=$(BROWSE)
PRINT=lpr
GHC=ghc
GHCI=ghci
GHCPKG=ghc-pkg
HADDOCK=haddock
CABAL=cabal
CABALINSTALL=cabal install -w $(GHC)
TESTFRAMEWORKOPTS=-j16 --hide-successes
SHELLTEST=cabal exec -- shelltest --execdir -- $(TESTFRAMEWORKOPTS)
# used for make auto, http://joyful.com/repos/searchpath
SP=sp
PACKAGES=\
hledger-lib \
hledger \
hledger-web
INCLUDEPATHS=\
-ihledger-lib \
-ihledger \
-ihledger-web \
-ihledger-web/app
MAIN=hledger/app/hledger-cli.hs
# all source files in the project (plus a few strays like Setup.hs & hlint.hs)
SOURCEFILES:= \
hledger/*hs \
hledger/Hledger/*hs \
hledger/Hledger/*/*hs \
hledger-*/*hs \
hledger-*/Hledger/*hs \
hledger-*/Hledger/*/*hs \
hledger-web/app/*.hs \
hledger-web/Handler/*.hs \
hledger-web/Hledger/*.hs \
hledger-web/Settings/*.hs
# # a more careful list suitable for for haddock-all
# HADDOCKSOURCEFILES:= \
# hledger-lib/Hledger.hs \
# hledger-lib/Hledger/*hs \
# hledger-lib/Hledger/*/*hs \
# hledger/Hledger/*hs \
# hledger/Hledger/*/*hs \
# hledger-web/Application.hs \
# hledger-web/Foundation.hs \
# hledger-web/Hledger/*hs \
# hledger-web/Hledger/*/*hs \
# hledger-web/Import.hs \
# hledger-web/Settings.hs \
# hledger-web/Settings/*hs \
# hledger-web/app/*hs \
CABALFILES:= \
hledger/hledger.cabal \
hledger-*/*.cabal
WEBFILES:= \
hledger-web/templates/* \
hledger-web/static/*.js \
hledger-web/static/*.css
DOCFILES:= \
doc/*.md
# files which should be updated when the version changes
VERSIONSENSITIVEFILES=\
$(CABALFILES) \
doc/manual.md \
# file(s) which require recompilation for a build to have an up-to-date version string
VERSIONSOURCEFILE=hledger/Hledger/Cli/Version.hs
# master file defining the current release/build version
VERSIONFILE=.version
# two or three-part version string, whatever's in VERSION
VERSION:=$(shell cat $(VERSIONFILE))
# the number of commits since the last tag
PATCHLEVEL:=$(shell git describe --long | awk -F - '{print $$2}')
# the number of commits since the last_release tag
#PATCHLEVEL:=$(shell git rev-list last_release..HEAD | wc -l)
# build flags
# comment the below to see more warnings
WARNINGS:=\
-Wall \
-fno-warn-unused-do-bind \
-fno-warn-name-shadowing \
-fno-warn-missing-signatures \
-fno-warn-orphans \
-fno-warn-type-defaults \
# For ghc-only dev builds of hledger-web: enable the language
# extensions specified in hledger-web.cabal, except for some which are
# not compatible with hledger-lib and hledger, or little-used; those
# are enabled with source file pragmas instead. Note: compilation
# warnings and errors might differ between ghc-only and cabal builds.
WEBLANGEXTS:=\
-XCPP \
-XMultiParamTypeClasses \
-XQuasiQuotes \
-XRecordWildCards \
-XTemplateHaskell \
# -XOverloadedStrings \
# -XNoImplicitPrelude \
# -XTypeFamilies \
# -XGADTs \
# -XGeneralizedNewtypeDeriving \
# -XFlexibleContexts \
# -XEmptyDataDecls \
# -XNoMonomorphismRestriction
PREFERMACUSRLIBFLAGS=-L/usr/lib
GHCMEMFLAGS= #+RTS -M200m -RTS
# include the macro definitions generated by cabal build,
# from either dist or dist-sandbox (hopefully you don't have both)
CABALMACROSFLAGS=-optP-include -optP hledger/dist*/build/autogen/cabal_macros.h
BUILDFLAGS1:=-rtsopts $(WARNINGS) $(INCLUDEPATHS) $(PREFERMACUSRLIBFLAGS) $(GHCMEMFLAGS) $(CABALMACROSFLAGS) -DPATCHLEVEL=$(PATCHLEVEL) -DDEVELOPMENT
BUILDFLAGS:=$(BUILDFLAGS1) -DVERSION='"$(VERSION)dev"'
PROFBUILDFLAGS:=-prof -fprof-auto -osuf hs_p
# sp needs different quoting:
AUTOBUILDFLAGS:=$(BUILDFLAGS1) -DVERSION='\"$(VERSION)dev\"' # $(PROFBUILDFLAGS)
LINUXRELEASEBUILDFLAGS:=-DMAKE $(WARNINGS) $(INCLUDEPATHS) -O2 -static -optl-static -optl-pthread
MACRELEASEBUILDFLAGS:=-DMAKE $(WARNINGS) $(INCLUDEPATHS) $(PREFERMACUSRLIBFLAGS) -O2 # -optl-L/usr/lib
#WINDOWSRELEASEBUILDFLAGS:=-DMAKE $(WARNINGS) $(INCLUDEPATHS)
AUTOBUILD=$(SP) --no-exts --no-default-map $(GHC) -O0 $(GHCMEMFLAGS)
# get an accurate binary filename for the current source and platform, slow but reliable. Avoid := here.
BINARYFILENAME=$(shell touch $(VERSIONSOURCEFILE); runhaskell -ihledger -ihledger-lib $(MAIN) --binary-filename)
# some other thing for linux binary filenames
RELEASEBINARYSUFFIX=$(shell echo "-$(VERSION)-`uname`-`arch`" | tr '[:upper:]' '[:lower:]')
TIME:=$(shell date +"%Y%m%d%H%M")
###############################################################################
$(call def-help-section,INSTALLING)
cabal-install: \
$(call def-help,cabal-install,\
cabal install the main hledger packages and all their dependencies\
in the sandbox if any; otherwise in the users package db\
)
$(CABALINSTALL) $(patsubst %,./%,$(PACKAGES)) $(EXTRAINSTALLARGS) --enable-tests
cabal-install-deps: \
$(call def-help,cabal-install-deps,\
cabal install the dependencies for the main hledger packages, but not the hledger packages \
)
$(CABALINSTALL) $(patsubst %,./%,$(PACKAGES)) $(EXTRAINSTALLARGS) --enable-tests --only-dependencies
# uninstall: \
# $(call def-help,uninstall,\
# unregister all packages, assuming they are defined lowest-dependency first\
# avoids some reinstall noise when repeatedly doing make install\
# )
# -for p in $(call reverse,$(PACKAGES)); do $(GHCPKG) unregister $$p; done
# utility function
reverse = $(if $(wordlist 2,2,$(1)),$(call reverse,$(wordlist 2,$(words $(1)),$(1))) $(firstword $(1)),$(1))
cabal%: \
$(call def-help,cabalCMD,\
run cabal CMD inside each hledger package directory\
)
for p in $(PACKAGES); do (echo doing cabal $* in $$p; cd $$p; cabal $*; echo); done
# # run a command in all hledger package dirs
# all%:
# for p in $(PACKAGES); do (echo doing $* in $$p; cd $$p; $*); done
###############################################################################
$(call def-help-section,DEVELOPER BUILDS)
EXTRAINSTALLARGS=
check-setup: \
$(call def-help,check-setup,\
run some tests to validate the development environment\
)
@echo sanity-checking developer environment:
@($(SHELLTEST) checks \
&& echo $@ PASSED) || echo $@ FAILED
auto: auto---version \
$(call def-help,auto,\
auto-recompile and run (something, eg --help or unit tests) whenever a module changes\
)
auto-%: sp \
$(call def-help,auto-%,\
\
)
$(AUTOBUILD) $(MAIN) -o bin/hledgerdev $(AUTOBUILDFLAGS) --run $*
autoweb: sp link-web-dirs \
$(call def-help,autoweb,\
\
)
$(AUTOBUILD) hledger-web/app/main.hs -o bin/hledger-webdev $(AUTOBUILDFLAGS) $(WEBLANGEXTS) --run -B --port 5001 --base-url http://localhost:5001 -f webtest.j
link-web-dirs: config messages static templates \
$(call def-help,link-web-dirs,\
\
)
config: \
$(call def-help,config,\
\
)
ln -sf hledger-web/$@
messages: \
$(call def-help,messages,\
\
)
ln -sf hledger-web/$@
static: \
$(call def-help,static,\
\
)
ln -sf hledger-web/$@
templates: \
$(call def-help,templates,\
\
)
ln -sf hledger-web/$@
sp: \
$(call def-help,sp,\
check for sp and explain how to get it if not found.\
)
@/usr/bin/env which sp >/dev/null || \
(echo '"sp" is required for auto-compilation. darcs get http://joyful.com/darcsden/simon/searchpath, make it (cabal install-ing any needed packages) and add it to your PATH'; exit 1)
# force a compile even if binary exists, since we don't specify dependencies for these
.PHONY: bin/hledgerdev bin/hledger-prof bin/hledgeropt bin/hledger-webdev
bin/hledgerdev: \
$(call def-help,bin/hledgerdev,\
build hledger developer binary, ie as quickly as possible\
requires cabal macros, generated by doing a cabal build in hledger/\
)
$(GHC) $(MAIN) -o bin/hledgerdev $(BUILDFLAGS)
bin/hledgerdev.ghc-%: $(SOURCEFILES) \
$(call def-help,bin/hledgerdev.ghc-%,\
build a GHC-version-specific hledger binary without disturbing with other GHC version builds\
)
ghc-$* $(MAIN) -o $@ $(BUILDFLAGS) -outputdir .ghc-$*
bin/hledgerdev.ghcall: \
bin/hledgerdev.ghc-7.6.1 \
bin/hledgerdev.ghc-7.4.1 \
bin/hledgerdev.ghc-7.2.2 \
bin/hledgerdev.ghc-7.0.4 \
$(call def-help,bin/hledgerdev.ghcall,\
build hledger with the main supported GHC versions\
)
bin/hledger: \
$(call def-help,bin/hledger,\
build the "production" optimised cabal build with profiling enabled. Assumes a cabal sandbox.\
)
rm -f bin/hledger
cabal install --disable-profiling ./hledger-lib ./hledger \
&& mv .cabal-sandbox/bin/hledger bin/hledger
bin/hledger-prof: \
$(call def-help,bin/hledger-prof,\
build the "production" cabal build with profiling enabled.\
)
rm -f bin/hledger-prof
cabal install --enable-profiling --ghc-options=-fprof-auto ./hledger-lib ./hledger \
&& mv .cabal-sandbox/bin/hledger bin/hledger-prof
# build the dev build with profiling enabled.
# not working with cabal sandbox
# bin/hledgerdev-prof:
# $(GHC) $(BUILDFLAGS) $(PROFBUILDFLAGS) $(MAIN) -o $@
hledgerhpc: \
$(call def-help,hledgerhpc,\
build the heap profiling binary for coverage reports and heap profiles.\
Keep these .o files separate from the regular ones.\
)
$(GHC) $(MAIN) -fhpc -o bin/hledgerhpc -outputdir .hledgerhpcobjs $(BUILDFLAGS)
# build other executables quickly
bin/hledger-webdev: link-web-dirs \
$(call def-help,bin/hledger-webdev,\
\
)
$(GHC) -o $@ $(BUILDFLAGS) $(WEBLANGEXTS) hledger-web/app/main.hs
bin/hledger-web-production: \
$(call def-help,bin/hledger-web-production,\
\
)
$(GHC) -o $@ $(BUILDFLAGS) $(WEBLANGEXTS) hledger-web/app/main.hs
linuxbinaries: linuxbinary-hledger \
linuxbinary-hledger-web \
$(call def-help,linuxbinaries,\
build portable releaseable binaries for gnu/linux\
)
@echo 'Please check the binaries look portable, then make compressbinaries:'
-file bin/*`arch`
linuxbinary-hledger: \
$(call def-help,linuxbinary-hledger,\
work around for inconsistently-named (why ?) hledger/app/hledger-cli.hs\
)
$(GHC) hledger/app/hledger-cli.hs -o bin/$*$(RELEASEBINARYSUFFIX) $(LINUXRELEASEBUILDFLAGS)
linuxbinary-%: \
$(call def-help,linuxbinary-%,\
\
)
$(GHC) $*/$*.hs -o bin/$*$(RELEASEBINARYSUFFIX) $(LINUXRELEASEBUILDFLAGS)
macbinaries: macbinary-hledger \
macbinary-hledger-web \
$(call def-help,macbinaries,\
\
)
@echo 'Please check the binaries are portable, then make compressbinaries'
otool -L bin/*`arch`
macbinary-%: \
$(call def-help,macbinary-%,\
build a deployable mac binary for the specified hledger package, munging\
the link command to use only standard osx libs. Specifically we link\
without the non-standard GMP framework, which causes no apparent harm.\
Clunky, does the link twice.\
)
BINARY=`echo $(BINARYFILENAME) | sed -e 's/hledger/$*/'` ; \
LINKCMD=`$(GHC) -v $*/$*.hs $(MACRELEASEBUILDFLAGS) -o bin/$$BINARY 2>&1 | egrep "bin/gcc.*bin/$$BINARY"` ; \
PORTABLELINKCMD=`echo $$LINKCMD | sed -e 's/ -framework GMP//'` ; \
echo $$PORTABLELINKCMD; $$PORTABLELINKCMD
windowsbinaries: install \
$(call def-help,windowsbinaries,\
Run this on a windows machine or in a wine session, and probably in a\
separate copy of the repo (hledger-win).\
Builds and gather deployable binaries for windows, if cygwin tools are\
present and all packages are buildable. Otherwise, cabal install each\
package and gather the binaries by hand.\
)
cp ~/.cabal/bin/hledger.exe bin/`echo $(BINARYFILENAME) | dos2unix`
-cp ~/.cabal/bin/hledger-web.exe bin/`echo $(BINARYFILENAME) | sed -e 's/hledger/hledger-web/' | dos2unix`
@echo 'Please check the binaries are portable, then make compressbinaries'
ls -l bin/*`arch`
wine-cmd: \
$(call def-help,wine-cmd,\
various ways of getting a wine shell\
command-line windows command prompt. Works eg in an emacs shell buffer.\
)
wine cmd
wine-cmd2: \
$(call def-help,wine-cmd2,\
as above but try to cd somewhere useful (doesnt work), also ctrl-d exits quickly\
)
(echo c:; echo cd \\mingw\\msys\\1.0; cat) | wine cmd
wine-cmd-window: \
$(call def-help,wine-cmd-window,\
windows command prompt in a new window\
)
wineconsole cmd &
wine-mintty: \
$(call def-help,wine-mintty,\
msys bash shell in a mintty window\
)
wine c:/mingw/msys/1.0/bin/mintty - &
compressbinaries: \
$(call def-help,compressbinaries,\
\
)
cd bin; for f in *-windows-*.exe ; do echo zipping $$f; rm -f $$f.zip; zip $$f.zip $$f; done
# for f in bin/*-{linux,mac-}* ; do echo gzipping $$f; gzip -q $$f >$$f.gz; done
# gzip bin/*`arch`
tools/unittest: tools/unittest.hs \
$(call def-help,tools/unittest,\
build the standalone unit test runner. Requires test-framework, which\
may not work on windows.\
)
$(GHC) -threaded -O2 tools/unittest.hs
tools/doctest: tools/doctest.hs \
$(call def-help,tools/doctest,\
build the doctest runner\
)
$(GHC) tools/doctest.hs
tools/simplebench: tools/simplebench.hs \
$(call def-help,tools/simplebench,\
build the simple benchmark runner. Requires html and tabular.\
)
$(GHC) tools/simplebench.hs
tools/criterionbench: tools/criterionbench.hs \
$(call def-help,tools/criterionbench,\
build the criterion-based benchmark runner. Requires criterion.\
)
$(GHC) tools/criterionbench.hs
tools/progressionbench: tools/progressionbench.hs \
$(call def-help,tools/progressionbench,\
build the progression-based benchmark runner. Requires progression.\
)
$(GHC) tools/progressionbench.hs
tools/generatejournal: tools/generatejournal.hs \
$(call def-help,tools/generatejournal,\
build the generatejournal tool\
)
$(GHC) tools/generatejournal.hs
###############################################################################
$(call def-help-section,TESTING)
packdeps: \
$(call def-help,packdeps,\
run packdeps on each package to check for disallowed newer dependencies\
)
for p in $(PACKAGES); do packdeps $$p/$$p.cabal; done
test: codetest \
$(call def-help,test,\
run default tests; ie codetest\
)
test-ghc-%: # bin/hledgerdev.ghc-$* \
$(call def-help,test-ghc-%,\
run default tests with a specific GHC version\
some functional tests (add, include, read-csv..) have bin/hledgerdev hard coded - might need to symlink it\
)
@echo; echo testing hledger built with ghc-$*
@(echo unit tests: \
&& bin/hledgerdev.ghc-$* test \
&& echo functional tests: \
&& $(SHELLTEST) tests -w bin/hledgerdev.ghc-$* \
&& echo $@ PASSED) || echo $@ FAILED
test-ghcall: bin/hledgerdev.ghcall \
test-ghc-7.6.1 \
test-ghc-7.4.1 \
test-ghc-7.2.2 \
test-ghc-7.0.4 \
$(call def-help,test-ghcall,\
run default tests with all supported GHC versions\
)
codetest: unittest functest \
$(call def-help,codetest,\
quick code tests, to be run frequently\
)
committest: hlinttest unittest doctest functest haddocktest warningstest quickcabaltest \
$(call def-help,committest,\
more thorough pre-commit/pre-push tests\
)
# releasetest: Clean unittest functest fullcabaltest haddocktest #warningstest doctest \
# $(call def-help,releasetest,\
# pre-release tests\
# )
hlinttest hlint: \
$(call def-help,hlinttest (or hlint),\
generate a hlint report\
)
hlint --hint=hlint --report=hlint.html $(SOURCEFILES)
unittest: bin/hledgerdev \
$(call def-help,unittest,\
run built-in unit tests\
)
@echo unit tests:
@(bin/hledgerdev test \
&& echo $@ PASSED) || echo $@ FAILED
unittest-%: bin/hledgerdev \
$(call def-help,unittest-PAT,\
run built-in unit tests whose name contains PAT\
)
@echo unit tests:
@(bin/hledgerdev test $* \
&& echo $@ PASSED) || echo $@ FAILED
# unittest-standalone: tools/unittest \
# $(call def-help,unittest-standalone,\
# XXX doesnt rebuild on hledger source changes\
# )
# @echo unit tests (standalone):
# @(tools/unittest \
# && echo $@ PASSED) || echo $@ FAILED
# unittest-interpreted: \
# $(call def-help,unittest-interpreted,\
# run unit tests without waiting for compilation\
# )
# @echo "unit tests (interpreted)":
# @(run$(GHC) $(MAIN) test \
# && echo $@ PASSED) || echo $@ FAILED
# shelltest -j16 sometimes gives "commitAndReleaseBuffer: resource vanished (Broken pipe)" here but seems harmless
functest: bin/hledgerdev tests/addons/hledger-addon \
$(call def-help,functest,\
run functional tests; requires shelltestrunner >= 0.9 from hackage\
)
@echo functional tests:
@(COLUMNS=80 PATH=`pwd`/bin:$(PATH) $(SHELLTEST) tests \
&& echo $@ PASSED) || echo $@ FAILED
ADDONEXTS=pl py rb sh hs lhs rkt exe com bat
tests/addons/hledger-addon: \
$(call def-help,tests/addons/hledger-addon,\
generate dummy add-ons for testing (hledger-addon the rest)\
)
rm -rf tests/addons/hledger-*
printf '#!/bin/sh\necho add-on: $$0\necho args: $$*\n' >tests/addons/hledger-addon
for E in '' $(ADDONEXTS); do \
cp tests/addons/hledger-addon tests/addons/hledger-addon.$$E; done
for F in addon. addon2 addon2.hs addon3.exe addon3.lhs addon4.exe add reg; do \
cp tests/addons/hledger-addon tests/addons/hledger-$$F; done
mkdir tests/addons/hledger-addondir
chmod +x tests/addons/hledger-*
DOCTESTFILES=\
hledger/Hledger/Cli/Tests.hs
doctest: tools/doctest \
$(call def-help,doctest,\
run doc tests\
)
@for f in $(DOCTESTFILES); do \
(tools/doctest $$f && echo $@ PASSED) || echo $@ FAILED ; done
haddocktest: \
$(call def-help,haddocktest,\
make sure we have no haddock errors\
)
@(make --quiet haddock \
&& echo $@ PASSED) || echo $@ FAILED
warningstest: \
$(call def-help,warningstest,\
make sure the normal build has no warnings XXX needs updating\
)
@(make -s clean \
&& make --no-print-directory -s hledgernowarnings \
&& echo $@ PASSED) || echo $@ FAILED
quickcabaltest: \
$(call def-help,quickcabaltest,\
make sure cabal is reasonably happy\
)
@(make --no-print-directory cabalclean cabalcheck cabalconfigure \
&& echo $@ PASSED) || echo $@ FAILED
fullcabaltest: \
$(call def-help,fullcabaltest,\
make sure cabal is happy in all possible ways\
)
(for p in $(PACKAGES); do ( \
printf "\ntesting $$p package\n" \
&& cd $$p \
&& cabal clean \
&& cabal check \
&& $(CABALINSTALL) \
&& cabal sdist \
); done \
&& echo $@ PASSED) || echo $@ FAILED
# && cabal upload dist/$$p-$(VERSION).tar.gz --check -v3 \
quickbench: samplejournals tests/bench.tests tools/simplebench \
$(call def-help,quickbench,\
run simple performance benchmarks without saving results\
Requires some commands defined in tests/bench.tests and some BENCHEXES defined above.\
)
tools/simplebench -v -ftests/bench.tests $(BENCHEXES)
@rm -f benchresults.*
bench: samplejournals tests/bench.tests tools/simplebench \
$(call def-help,bench,\
run simple performance benchmarks and archive results\
Requires some commands defined in tests/bench.tests and some BENCHEXES defined above.\
)
tools/simplebench -v -ftests/bench.tests $(BENCHEXES) | tee doc/profs/$(TIME).bench
@rm -f benchresults.*
@(cd doc/profs; rm -f latest.bench; ln -s $(TIME).bench latest.bench)
criterionbench: samplejournals tools/criterionbench \
$(call def-help,criterionbench,\
run criterion benchmark tests and save graphical results\
)
tools/criterionbench -t png -k png
progressionbench: samplejournals tools/progressionbench \
$(call def-help,progressionbench,\
run progression benchmark tests and save graphical results\
)
tools/progressionbench -- -t png -k png
prof: samplejournals \
$(call def-help,prof,\
generate and archive an execution profile\
) #bin/hledger-prof
@echo "Profiling: $(PROFCMD)"
-$(PROFCMD) +RTS $(PROFRTSFLAGS) -RTS
mv hledger-prof.prof doc/profs/$(TIME).prof
(cd doc/profs; rm -f latest*.prof; ln -s $(TIME).prof latest.prof)
viewprof: prof \
$(call def-help,viewprof,\
generate, archive, simplify and display an execution profile\
)
tools/simplifyprof.hs doc/profs/latest.prof
quickprof: samplejournals \
$(call def-help,quickprof,\
generate and display an execution profile, dont save or simplify\
) #bin/hledger-prof
@echo "Profiling: $(PROFCMD)"
-$(PROFCMD) +RTS $(PROFRTSFLAGS) -RTS
echo; cat hledger-prof.prof
heap: samplejournals \
$(call def-help,heap,\
generate and archive a graphical heap profile\
) #bin/hledger-prof
@echo "Profiling heap with: $(PROFCMD)"
$(PROFCMD) +RTS -hc -RTS
mv hledger-prof.hp doc/profs/$(TIME).hp
(cd doc/profs; rm -f latest.hp; ln -s $(TIME).hp latest.hp; \
hp2ps $(TIME).hp; rm -f latest.ps; ln -s $(TIME).ps latest.ps; rm -f *.aux)
viewheap: heap \
$(call def-help,viewheap,\
\
)
$(VIEWPS) doc/profs/latest.ps
quickheap: samplejournals \
$(call def-help,quickheap,\
generate and display a graphical heap profile, dont save\
) #bin/hledger-prof
@echo "Profiling heap with: $(PROFCMD)"
$(PROFCMD) +RTS -hc -RTS
hp2ps hledger-prof.hp
$(VIEWPS) hledger.ps
quickcoverage: hledgerhpc \
$(call def-help,quickcoverage,\
display a code coverage text report from running hledger COVCMD\
)
@echo "Generating code coverage text report for hledger command: $(COVCMD)"
tools/runhledgerhpc "report" $(COVCMD)
coverage: samplejournals hledgerhpc \
$(call def-help,coverage,\
generate a code coverage html report from running hledger COVCMD\
)
@echo "Generating code coverage html report for hledger command: $(COVCMD)"
tools/runhledgerhpc "markup --destdir=doc/profs/coverage" $(COVCMD)
cd doc/profs/coverage; rm -f index.html; ln -s hpc_index.html index.html
viewcoverage: \
$(call def-help,viewcoverage,\
view the last html code coverage report\
)
$(VIEWHTML) doc/profs/coverage/index.html
# XXX with a sandbox, use sandbox-repl-* instead
repl-lib:\
$(call def-help,repl-lib, start a cabal REPL and load the hledger-lib package)
(cd hledger-lib; cabal repl)
repl-cli:\
$(call def-help,repl-cli, start a cabal REPL and load the hledger package)
(cd hledger; cabal repl exe:hledger)
repl-web:\
$(call def-help,repl-web, start a cabal REPL and load the hledger-web package)
(cd hledger-web; cabal repl exe:hledger-web)
ghci: \
$(call def-help,ghci, start a sandbox-aware GHCI REPL and load the hledger-lib and hledger packages)
cabal exec $(GHCI) -- $(BUILDFLAGS) hledger/Hledger/Cli/Main.hs
ghci-web: \
$(call def-help,ghci-web, start a sandbox-aware GHCI REPL and load the hledger-lib, hledger and hledger-web packages)
cabal exec $(GHCI) -- $(BUILDFLAGS) hledger-web/app/main.hs
samplejournals: data/sample.journal data/100x100x10.journal data/1000x1000x10.journal data/1000x10000x10.journal data/10000x1000x10.journal data/10000x10000x10.journal data/100000x1000x10.journal \
$(call def-help,samplejournals,\
generate standard sample journals in data/\
)
data/sample.journal:
true # XXX should probably regenerate this
data/100x100x10.journal: tools/generatejournal
tools/generatejournal 100 100 10 >$@
data/1000x1000x10.journal: tools/generatejournal
tools/generatejournal 1000 1000 10 >$@
data/1000x10000x10.journal: tools/generatejournal
tools/generatejournal 1000 10000 10 >$@
data/10000x1000x10.journal: tools/generatejournal
tools/generatejournal 10000 1000 10 >$@
data/10000x10000x10.journal: tools/generatejournal
tools/generatejournal 10000 10000 10 >$@
data/100000x1000x10.journal: tools/generatejournal
tools/generatejournal 100000 1000 10 >$@
###############################################################################
$(call def-help-section,DOCUMENTATION)
docs: site codedocs \
$(call def-help,docs,\
rebuild all docs\
)
cleandocs: site-clean \
$(call def-help,cleandocs,\
\
)
site-build site: \
$(call def-help,site-build site,\
build some additional static bits of the hledger.org website\
Requires hakyll-std, a generic hakyll site builder\
) #olddocs
-cd doc/site; hakyll build
site-clean: \
$(call def-help,site-clean,\
\
) #cleanolddocs
-cd doc/site; hakyll clean
# rm -rf doc/site/_site/*
site-preview: \
$(call def-help,site-preview,\
\
) #doc/site/site
cd doc/site; hakyll preview
site-view: site \
$(call def-help,site-view,\
\
)
$(VIEWHTML) doc/site/_site/index.html
# site-auto:
# cd doc/site; $(AUTOBUILD) site.hs -o site $(PREFERMACUSRLIBFLAGS) --run preview
# ensure some old doc versions are in place:
#olddocs: doc/0.22 doc/0.21
#doc/0.23:
# (cd doc; git archive --prefix doc/0.23/ tags/0.23 'doc/MANUAL.md') | tar xf -
# doc/0.22:
# git archive --prefix doc/0.22/ tags/0.22 'MANUAL.md' | tar xf -
# doc/0.21:
# git archive --prefix doc/0.21/ tags/0.21.3 'MANUAL.md' | tar xf -
# cleanolddocs:
# cd doc; rm -rf 0.22 0.21
pdf: codepdf \
$(call def-help,pdf,\
\
) #docspdf
# generate pdf versions of main docs
# docspdf:
# -for d in $(DOCFILES); do (cd site && ln -sf ../$$d && pandoc $$d -w pdf && rm -f $$d); done
# # format all code as a pdf for offline reading
# ENSCRIPT=enscript -q --header='$$n|$$D{%+}|Page $$% of $$=' --highlight=haskell --line-numbers --font=Courier6 --color -o-
# codepdf:
# $(ENSCRIPT) --pretty-print=makefile hledger.cabal >cabal.ps
# $(ENSCRIPT) --pretty-print=makefile Makefile >make.ps
# $(ENSCRIPT) --pretty-print=haskell $(SOURCEFILES) >haskell.ps
# cat cabal.ps make.ps haskell.ps | ps2pdf - >code.pdf
# # view all docs and code as pdf
# PDFS=site/{README,README2,MANUAL,CHANGES,CONTRIBUTORS}.pdf code.pdf
# viewall: pdf
# $(VIEWPDF) $(PDFS)
# # print all docs and code for offline reading
# printall: pdf
# $(PRINT) $(PDFS)
pushdocs: push \
$(call def-help,pushdocs,\
push latest docs etc. and update the hledger.org site\
)
ssh simon@joyful.com 'make -C/repos/hledger docs'
EXES=hledger hledger-vty hledger-web
savehelp: \
$(call def-help,savehelp,\
dump all executables command line help into files for review\
)
for e in $(EXES); do $$e --help >.HELP_$$e; done
codedocs: haddock hscolour coverage \
$(call def-help,codedocs,\
generate api & other code docs\
) #sourcegraph #hoogle
# cf http://www.haskell.org/haddock/doc/html/invoking.html
# --ghc-options=-optP-P is a workaround for http://trac.haskell.org/haddock/ticket/284
HADDOCKFLAGS= \
--haddock-options='--no-warnings' \
--ghc-options='-optP-P' \
haddock: haddock-lib haddock-cli haddock-web \
$(call def-help,haddock,build all package haddocks using cabal)
haddock-lib:
(cd hledger-lib; cabal haddock $(HADDOCKFLAGS))
haddock-cli:
(cd hledger; cabal haddock $(HADDOCKFLAGS))
haddock-web:
(cd hledger-web; cabal haddock $(HADDOCKFLAGS))
view-haddock-cli: \
$(call def-help,view-haddock-cli,\
view the haddock generated for the hledger package\
)
$(VIEWHTML) hledger/dist/doc/html/hledger/index.html
view-haddock-%: \
$(call def-help,view-haddock-PKG,\
view the haddock generated for the hledger-PKG package\
)
$(VIEWHTML) hledger-$*/dist/doc/html/hledger-$*/index.html
# HADDOCKALLFLAGS= \
# --no-warnings \
# --prologue .haddockallprologue \
# --optghc='-optP-include' \
# --optghc='-optPhledger/dist/build/autogen/cabal_macros.h'
# # --optghc='-XCPP'
# # --optghc="$(WEBLANGEXTS)"
# # --optghc='-hide-package monads-tf'
#$(subst -D,--optghc=-D,$(DEFINEFLAGS))
#
# # .haddockallsynopsis: hledger/hledger.cabal
# # grep synopsis $< | sed -e 's/synopsis: *//' >$@
#
# .haddockallprologue: hledger/hledger.cabal
# cat $< | perl -ne 'print if (/^description:/../^$$/)' | sed -e 's/^description: *//' >$@
# printf "\nThis haddock covers all hledger-* packages, for individual package haddocks see hackage.\n" >>$@
#
# # build haddock docs for the whole project
# haddock-all: .haddockallprologue
# $(HADDOCK) \
# $(HADDOCKALLFLAGS) \
# --title "hledger-* API docs" \
# -o site/api \
# --html \
# --source-module=src/%{MODULE/./-}.html \
# --source-entity=src/%{MODULE/./-}.html#%N \
# $(HADDOCKSOURCEFILES)
#
# # browse the whole-project haddock
# view-haddock-all:
# $(VIEWHTML) site/api/frames.html
# http://www.cs.york.ac.uk/fp/darcs/hscolour/
HSCOLOUR=HsColour -css
hscolour: doc/site/api/src doc/site/api/src/hscolour.css \
$(call def-help,hscolour,\
\
)
for f in $(HADDOCKSOURCEFILES); do \
$(HSCOLOUR) -anchor $$f -odoc/site/api/src/`echo $$f | sed -e's%[^/]*/%%' | sed -e's%/%-%g' | sed -e's%\.hs$$%.html%'` ; \
done
doc/site/api/src/hscolour.css: doc/site/api/src \
$(call def-help,doc/site/api/src/hscolour.css,\
\
)
$(HSCOLOUR) -print-css >doc/site/api/src/hscolour.css
doc/site/api/src: \
$(call def-help,doc/site/api/src,\
\
)
mkdir -p doc/site/api/src
sourcegraph: \
$(call def-help,sourcegraph,\
\
)
for p in $(PACKAGES); do (cd $$p; SourceGraph $$p.cabal); done
# # generate external api docs for each package
# allhaddock: cabalhaddock\ --hyperlink-source\ --executables
# # generate internal code docs for each package
# allhaddockinternal: cabalhaddock\ --hyperlink-source\ --executables\ --internal
# # generate hoogle indices for each package
# allhoogle: cabalhaddock\ --hoogle\ --executables
#set up the hoogle web interface
## We munge haddock and hoogle into a rough but useful framed layout.
## For this to work the hoogle cgi must be built with base target "main".
## XXX move the framed index building into haddock: ?
# sed -i -e 's%^></HEAD%><base target="main"></HEAD%' site/api/modules-index.html ; \
# cp site/api-frames.html site/api/index.html ; \
# # cp site/hoogle-small.html site/api
#
#uses a hoogle source tree configured with --datadir=., patched to fix haddock urls/target frame
# HOOGLESRC=/usr/local/src/hoogle
# HOOGLE=$(HOOGLESRC)/dist/build/hoogle/hoogle
# HOOGLEVER=`$(HOOGLE) --version |tail -n 1 | sed -e 's/Version /hoogle-/'`
# hoogle: hoogleindex
# if test -f $(HOOGLE) ; then \
# cd site/api && \
# rm -f $(HOOGLEVER) && \
# ln -s . $(HOOGLEVER) && \
# cp -r $(HOOGLESRC)/src/res/ . && \
# cp -p $(HOOGLE) index.cgi && \
# touch log.txt && chmod 666 log.txt ; \
# else \
# echo "Could not find $(HOOGLE) in the hoogle source tree" ; \
# fi
#
#generate a hoogle index