f03b020e2f
hledger and hledger-web were reading their version number (and program name) from their cabal files at compile time using cabal-file-th, which allowed the version number be maintained in one place (per package). This meant you had to be in same directory as the cabal file when building, which made life more complicated, eg emacs compilation mode could not jump to errors. Also, it slowed down building slightly, and is a factor in hledger Debian packages being unavailable on a number of platforms (we also use TH for report templates). Now, the build version is set with a CPP VERSION flag, which seems simpler overall. For cabal builds, this needs to be configured manually in a few more places in each cabal file. For makefile builds, it is set it to the name of the most recent darcs tag (which should be more useful than the old behaviour). If not set, it defaults to the blank string, useful eg for haddock. And, all makefile builds now run from the top directory.
907 lines
30 KiB
Makefile
907 lines
30 KiB
Makefile
# hledger project makefile
|
|
|
|
# ghc 6.12 executables need a locale
|
|
export LANG=en_US.UTF-8
|
|
|
|
# command line to run during "make prof" and "make heap"
|
|
PROFCMD=bin/hledgerp balance -f data/100x100x10.journal >/dev/null
|
|
#PROFCMD=bin/hledgerp balance >/dev/null
|
|
|
|
#PROFRTSFLAGS=-p
|
|
PROFRTSFLAGS=-P
|
|
|
|
# command to run during "make coverage"
|
|
COVCMD=test
|
|
|
|
# executables to run during "make simplebench". They should be on the path
|
|
# or in the current directory. hledger executables for benchmarking should
|
|
# generally be the standard optimised cabal build, constrained to parsec 2.
|
|
BENCHEXES=hledger-0.12.1 hledger-0.13 hledger-0.14 hledger-0.15 hledger-0.16 hledger-0.17 hledger-0.18 hledgeropt ledger
|
|
#BENCHEXES=hledger
|
|
|
|
# misc. tools
|
|
BROWSE=google-chrome
|
|
BROWSE=open -a 'Google Chrome'
|
|
VIEWHTML=$(BROWSE)
|
|
VIEWPS=$(BROWSE)
|
|
VIEWPDF=$(BROWSE)
|
|
PRINT=lpr
|
|
|
|
PACKAGES=\
|
|
hledger-lib \
|
|
hledger \
|
|
hledger-web \
|
|
# hledger-vty \
|
|
# hledger-chart
|
|
INCLUDEPATHS=\
|
|
-i../hledger-lib \
|
|
-i../hledger \
|
|
-i../hledger-web \
|
|
# -i../hledger-vty \
|
|
# -i../hledger-chart
|
|
MAIN=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/Hledger/Web/Settings/*hs
|
|
|
|
# a more careful list suitable for for haddock
|
|
HADDOCKSOURCEFILES:= \
|
|
hledger-lib/*hs \
|
|
hledger-lib/Hledger/*hs \
|
|
hledger-lib/Hledger/*/*hs \
|
|
hledger/Hledger/*hs \
|
|
hledger/Hledger/*/*hs \
|
|
hledger-web/Hledger/*hs \
|
|
hledger-web/Hledger/*/*hs \
|
|
hledger-web/Hledger/Web/Settings/*hs \
|
|
# hledger-vty/Hledger/*hs \
|
|
# hledger-vty/Hledger/*/*hs
|
|
# hledger-chart/Hledger/*hs
|
|
# hledger-chart/Hledger/*/*hs
|
|
|
|
CABALFILES:= \
|
|
hledger/hledger.cabal \
|
|
hledger-*/*.cabal
|
|
|
|
WEBFILES:= \
|
|
hledger-web/static/*.js \
|
|
hledger-web/static/*.css
|
|
# hledger-web/templates/* \
|
|
|
|
DOCFILES:= \
|
|
*.md
|
|
|
|
LASTTAG:=$(shell darcs show tags | head -1)
|
|
PATCHLEVEL:=$(shell expr `darcs changes --count --from-tag=\\\\\.` - 1)
|
|
WARNINGS:=-W -fwarn-tabs -fno-warn-name-shadowing #-fwarn-orphans -fwarn-simple-patterns -fwarn-monomorphism-restriction
|
|
PREFERMACUSRLIBFLAGS=-L/usr/lib
|
|
GHCMEMFLAGS= #+RTS -M200m -RTS
|
|
BUILDFLAGS1:=-rtsopts -DMAKE -DPATCHLEVEL=$(PATCHLEVEL) $(WARNINGS) $(INCLUDEPATHS) $(PREFERMACUSRLIBFLAGS) $(GHCMEMFLAGS) $(HCFLAGS)
|
|
BUILDFLAGS:=$(BUILDFLAGS1) -DVERSION='"$(LASTTAG)"'
|
|
AUTOBUILDFLAGS:=$(BUILDFLAGS1) -DVERSION='\"$(LASTTAG)\"' # different quoting for sp
|
|
PROFBUILDFLAGS:=-prof -osuf hs_p #-prof-auto
|
|
LINUXRELEASEBUILDFLAGS:=-DMAKE $(WARNINGS) $(INCLUDEPATHS) -O2 -static -optl-static -optl-pthread
|
|
MACRELEASEBUILDFLAGS:=-DMAKE $(WARNINGS) $(INCLUDEPATHS) $(PREFERMACUSRLIBFLAGS) -O2 # -optl-L/usr/lib
|
|
#WINDOWSRELEASEBUILDFLAGS:=-DMAKE $(WARNINGS) $(INCLUDEPATHS)
|
|
TIME:=$(shell date +"%Y%m%d%H%M")
|
|
|
|
# searchpath executable used for automatic recompilation, http://joyful.com/repos/searchpath
|
|
GHC=ghc
|
|
AUTOBUILD=sp --no-exts --no-default-map $(GHC) --make -O0 $(GHCMEMFLAGS)
|
|
|
|
# file defining the current release version
|
|
VERSIONFILE=VERSION
|
|
# two or three-part version string, whatever's in VERSION
|
|
VERSION:=$(shell grep -v '^--' $(VERSIONFILE))
|
|
# three-part version string, 0-padded if necessary
|
|
ifeq ($(shell ghc -e "length (filter (=='.') \"$(VERSION)\")"), 1)
|
|
VERSION3:=$(VERSION).0
|
|
else
|
|
VERSION3:=$(VERSION)
|
|
endif
|
|
# files which should be updated when the version changes
|
|
VERSIONSENSITIVEFILES=\
|
|
$(CABALFILES) \
|
|
MANUAL.md \
|
|
# DOWNLOAD.md \
|
|
# source file which should be touched to ensure up to date version string
|
|
VERSIONHS=hledger/Hledger/Cli/Version.hs
|
|
|
|
# get an accurate binary filename from the current source on the current platform
|
|
# nb not := as that would break the makefile when hledger is not compiling.
|
|
BINARYFILENAME=$(shell touch $(VERSIONHS); runhaskell -ihledger -ihledger-lib $(MAIN) --binary-filename)
|
|
|
|
RELEASEBINARYSUFFIX:=$(shell echo "-$(VERSION)-`uname`-`arch`" | tr '[:upper:]' '[:lower:]')
|
|
|
|
default: tag bin/hledger
|
|
|
|
######################################################################
|
|
# BUILDING
|
|
|
|
# cabal install all hledger PACKAGES and dependencies in the proper order
|
|
# (or, as many as possible)
|
|
EXTRAINSTALLARGS=
|
|
install:
|
|
cabal install $(patsubst %,./%,$(PACKAGES)) $(EXTRAINSTALLARGS)
|
|
|
|
# run a cabal command in all hledger package dirs
|
|
allcabal%:
|
|
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
|
|
|
|
# auto-recompile and run (something, eg --help or unit tests) whenever a module changes
|
|
|
|
auto: sp
|
|
$(AUTOBUILD) $(MAIN) -o bin/hledger $(AUTOBUILDFLAGS) --run --version
|
|
|
|
autotest: sp
|
|
$(AUTOBUILD) $(MAIN) -o bin/hledger $(AUTOBUILDFLAGS) --run test
|
|
|
|
autotest-%: sp
|
|
$(AUTOBUILD) $(MAIN) -o bin/hledger $(AUTOBUILDFLAGS) --run test $*
|
|
|
|
autoweb: sp
|
|
cd hledger-web; $(AUTOBUILD) hledger-web.hs -o bin/hledger-web $(AUTOBUILDFLAGS) -DDEVELOPMENT --run -B --port 5001 --base-url http://localhost:5001 -f test.journal
|
|
|
|
autovty: sp
|
|
cd hledger-vty; $(AUTOBUILD) hledger-vty.hs -o bin/hledger-vty $(AUTOBUILDFLAGS) --run --help
|
|
|
|
autochart: sp
|
|
cd hledger-chart; $(AUTOBUILD) hledger-chart.hs -o bin/hledger-chart $(AUTOBUILDFLAGS) --run --help
|
|
|
|
# check for sp and explain how to get it if not found.
|
|
sp:
|
|
@/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)
|
|
|
|
hledgerall: bin/hledger hledger-web hledger-vty hledger-chart
|
|
|
|
# force a compile even if binary exists, since we don't specify dependencies
|
|
.PHONY: bin/hledger hledger-web hledger-vty hledger-chart
|
|
|
|
# build hledger binary as quickly as possible
|
|
bin/hledger:
|
|
ghc --make $(MAIN) -o bin/hledger $(BUILDFLAGS)
|
|
|
|
# build a GHC-version-specific hledger binary without disturbing with other GHC version builds
|
|
bin/hledger.ghc-%: $(SOURCEFILES)
|
|
ghc-$* --make $(MAIN) -o $@ $(BUILDFLAGS) -outputdir .ghc-$*
|
|
|
|
# build hledger with the main supported GHC versions
|
|
bin/hledger.ghcall: \
|
|
bin/hledger.ghc-7.6.1 \
|
|
bin/hledger.ghc-7.4.1 \
|
|
bin/hledger.ghc-7.2.2 \
|
|
bin/hledger.ghc-7.0.4 \
|
|
# bin/hledger.ghc-6.12.3 \
|
|
|
|
# build the fastest binary we can
|
|
bin/hledgeropt:
|
|
ghc --make $(MAIN) -o $@ $(BUILDFLAGS) -O2 # -fvia-C # -fexcess-precision -optc-O3 -optc-ffast-math
|
|
|
|
# build the time profiling binary. cabal install --reinstall -p some libs may be required.
|
|
bin/hledgerp:
|
|
ghc --make $(MAIN) -o $@ $(BUILDFLAGS) $(PROFBUILDFLAGS)
|
|
|
|
# build the heap profiling binary for coverage reports and heap profiles.
|
|
# Keep these .o files separate from the regular ones.
|
|
hledgerhpc:
|
|
ghc --make $(MAIN) -fhpc -o bin/hledgerhpc -outputdir .hledgerhpcobjs $(BUILDFLAGS)
|
|
|
|
# build other executables quickly
|
|
|
|
bin/hledger-web:
|
|
cd hledger-web; ghc --make hledger-web.hs -o bin/hledger-web $(BUILDFLAGS)
|
|
|
|
bin/hledger-web-production:
|
|
cd hledger-web; ghc --make hledger-web.hs -o $@ $(BUILDFLAGS)
|
|
|
|
bin/hledger-vty:
|
|
cd hledger-vty; ghc --make hledger-vty.hs -o bin/hledger-vty $(BUILDFLAGS)
|
|
|
|
bin/hledger-chart:
|
|
cd hledger-chart; ghc --make hledger-chart.hs -o bin/hledger-chart $(BUILDFLAGS)
|
|
|
|
# build portable releaseable binaries for gnu/linux
|
|
linuxbinaries: linuxbinary-hledger \
|
|
linuxbinary-hledger-web \
|
|
linuxbinary-hledger-vty \
|
|
linuxbinary-hledger-chart
|
|
@echo 'Please check the binaries look portable, then make compressbinaries:'
|
|
-file bin/*`arch`
|
|
|
|
linuxbinary-%:
|
|
ghc --make $*/$*.hs -o bin/$*$(RELEASEBINARYSUFFIX) $(LINUXRELEASEBUILDFLAGS)
|
|
|
|
# XXX link errors
|
|
linuxbinary-hledger-chart:
|
|
ghc --make hledger-chart/hledger-chart.hs -o bin/hledger-chart$(RELEASEBINARYSUFFIX) $(LINUXRELEASEBUILDFLAGS) -lpixman-1 -v
|
|
|
|
macbinaries: macbinary-hledger \
|
|
macbinary-hledger-vty \
|
|
macbinary-hledger-web \
|
|
macbinary-hledger-chart
|
|
@echo 'Please check the binaries are portable, then make compressbinaries'
|
|
otool -L bin/*`arch`
|
|
|
|
# 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.
|
|
macbinary-%:
|
|
BINARY=`echo $(BINARYFILENAME) | sed -e 's/hledger/$*/'` ; \
|
|
LINKCMD=`cd $* && ghc -v --make $*.hs $(MACRELEASEBUILDFLAGS) -o bin/$$BINARY 2>&1 | egrep "bin/gcc.*bin/$$BINARY"` ; \
|
|
PORTABLELINKCMD=`echo $$LINKCMD | sed -e 's/ -framework GMP//'` ; \
|
|
echo $$PORTABLELINKCMD; $$PORTABLELINKCMD
|
|
|
|
# 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.
|
|
windowsbinaries: install
|
|
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`
|
|
-cp ~/.cabal/bin/hledger-vty.exe bin/`echo $(BINARYFILENAME) | sed -e 's/hledger/hledger-vty/' | dos2unix`
|
|
-cp ~/.cabal/bin/hledger-chart.exe bin/`echo $(BINARYFILENAME) | sed -e 's/hledger/hledger-chart/' | dos2unix`
|
|
@echo 'Please check the binaries are portable, then make compressbinaries'
|
|
ls -l bin/*`arch`
|
|
|
|
# One way to get a wine command prompt
|
|
wine:
|
|
wineconsole cmd.exe &
|
|
|
|
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`
|
|
|
|
# build the standalone unit test runner. Requires test-framework, which
|
|
# may not work on windows.
|
|
tools/unittest: tools/unittest.hs
|
|
ghc --make -threaded -O2 tools/unittest.hs
|
|
|
|
# build the doctest runner
|
|
tools/doctest: tools/doctest.hs
|
|
ghc --make tools/doctest.hs
|
|
|
|
# build the simple benchmark runner. Requires tabular.
|
|
tools/simplebench: tools/simplebench.hs
|
|
ghc --make tools/simplebench.hs
|
|
|
|
# build the criterion-based benchmark runner. Requires criterion.
|
|
tools/criterionbench: tools/criterionbench.hs
|
|
ghc --make tools/criterionbench.hs
|
|
|
|
# build the progression-based benchmark runner. Requires progression.
|
|
tools/progressionbench: tools/progressionbench.hs
|
|
ghc --make tools/progressionbench.hs
|
|
|
|
# build the generatejournal tool
|
|
tools/generatejournal: tools/generatejournal.hs
|
|
ghc --make tools/generatejournal.hs
|
|
|
|
######################################################################
|
|
# TESTING
|
|
|
|
|
|
######################################################################
|
|
# DOCUMENTATION
|
|
|
|
|
|
######################################################################
|
|
# RELEASING
|
|
|
|
# set up this repo copy for previewing a release:
|
|
# ensure download links work
|
|
set-up-rc-repo:
|
|
cd site/_site; ln -s ../download
|
|
|
|
######################################################################
|
|
# MISCELLANEOUS
|
|
|
|
|
|
|
|
######################################################################
|
|
# OLD PRE PKG SPLIT
|
|
######################################################################
|
|
|
|
######################################################################
|
|
# TESTING
|
|
|
|
SHELLTEST=shelltest
|
|
|
|
test: codetest
|
|
|
|
# quick code tests - run all the time
|
|
codetest: unittest functest
|
|
|
|
# moderate pre-commit tests - run before record or before send/push, your choice
|
|
committest: hlinttest unittest doctest functest haddocktest warningstest quickcabaltest
|
|
|
|
# thorough pre-release tests - run before release
|
|
# consider hiding dev-build symlinks in Hledger/ first
|
|
releasetest: Clean unittest doctest functest warningstest fullcabaltest haddocktest
|
|
|
|
hlinttest hlint:
|
|
hlint --hint=hlint --report=hlint.html $(SOURCEFILES)
|
|
|
|
# run unit tests
|
|
unittest: unittest-builtin
|
|
|
|
unittest-builtin: bin/hledger
|
|
@echo unit tests:
|
|
@(bin/hledger test \
|
|
&& echo $@ PASSED) || echo $@ FAILED
|
|
|
|
# XXX doesn't rebuild on hledger source changes
|
|
unittest-standalone: tools/unittest
|
|
@echo unit tests (standalone):
|
|
@(tools/unittest \
|
|
&& echo $@ PASSED) || echo $@ FAILED
|
|
|
|
# run unit tests without waiting for compilation
|
|
unittest-interpreted:
|
|
@echo unit tests (interpreted):
|
|
@(runghc $(MAIN) test \
|
|
&& echo $@ PASSED) || echo $@ FAILED
|
|
|
|
# run functional tests, requires shelltestrunner >= 0.9 from hackage
|
|
# 16 threads sometimes gives "commitAndReleaseBuffer: resource vanished (Broken pipe)" here but seems harmless
|
|
functest: bin/hledger
|
|
@echo functional tests:
|
|
($(SHELLTEST) tests -- --threads=16 --hide-successes \
|
|
&& echo $@ PASSED) || echo $@ FAILED
|
|
|
|
# run unit and functional tests with a specific GHC version
|
|
# some functional tests (add, include, read-csv..) have bin/hledger hard coded - might need to symlink it
|
|
test-ghc-%: # bin/hledger.ghc-$*
|
|
@echo; echo testing hledger built with ghc-$*
|
|
@(echo unit tests: \
|
|
&& bin/hledger.ghc-$* test \
|
|
&& echo functional tests: \
|
|
&& $(SHELLTEST) tests -w bin/hledger.ghc-$* -- --threads=16 --hide-successes \
|
|
&& echo $@ PASSED) || echo $@ FAILED
|
|
|
|
# run unit and functional tests with main supported GHC versions
|
|
test-ghcall: bin/hledger.ghcall \
|
|
test-ghc-7.6.1 \
|
|
test-ghc-7.4.1 \
|
|
test-ghc-7.2.2 \
|
|
test-ghc-7.0.4 \
|
|
# test-ghc-6.12.3 \
|
|
|
|
# run doc tests
|
|
DOCTESTFILES=\
|
|
hledger/Hledger/Cli/Tests.hs
|
|
doctest: tools/doctest
|
|
@for f in $(DOCTESTFILES); do \
|
|
(tools/doctest $$f && echo $@ PASSED) || echo $@ FAILED ; done
|
|
|
|
# make sure we have no haddock errors
|
|
haddocktest:
|
|
@(make --quiet haddock \
|
|
&& echo $@ PASSED) || echo $@ FAILED
|
|
|
|
# needs updating
|
|
# make sure the normal build has no warnings
|
|
warningstest:
|
|
@(make -s clean \
|
|
&& make --no-print-directory -s hledgernowarnings \
|
|
&& echo $@ PASSED) || echo $@ FAILED
|
|
|
|
# make sure cabal is reasonably happy
|
|
quickcabaltest:
|
|
@(make --no-print-directory allcabalclean allcabalcheck allcabalconfigure \
|
|
&& echo $@ PASSED) || echo $@ FAILED
|
|
|
|
# make sure cabal is happy in all possible ways
|
|
fullcabaltest:
|
|
(for p in $(PACKAGES); do (echo "testing $$p package" && cd $$p && cabal clean && cabal check && cabal install && cabal sdist && cabal upload dist/$$p-$(VERSION).tar.gz --check -v3); done \
|
|
&& echo $@ PASSED) || echo $@ FAILED
|
|
|
|
# run simple performance benchmarks without saving results
|
|
# Requires some commands defined in bench.tests and some BENCHEXES defined above.
|
|
quickbench: samplejournals bench.tests tools/simplebench
|
|
tools/simplebench -fbench.tests $(BENCHEXES)
|
|
@rm -f benchresults.*
|
|
|
|
# run simple performance benchmarks and archive results
|
|
# Requires some commands defined in bench.tests and some BENCHEXES defined above.
|
|
simplebench: samplejournals bench.tests tools/simplebench
|
|
tools/simplebench -fbench.tests $(BENCHEXES) | tee profs/$(TIME).bench
|
|
@rm -f benchresults.*
|
|
@(cd profs; rm -f latest.bench; ln -s $(TIME).bench latest.bench)
|
|
|
|
# run criterion benchmark tests and save graphical results
|
|
criterionbench: samplejournals tools/criterionbench
|
|
tools/criterionbench -t png -k png
|
|
|
|
# run progression benchmark tests and save graphical results
|
|
progressionbench: samplejournals tools/progressionbench
|
|
tools/progressionbench -- -t png -k png
|
|
|
|
# generate and archive an execution profile
|
|
prof: samplejournals bin/hledgerp
|
|
@echo "Profiling: $(PROFCMD)"
|
|
-$(PROFCMD) +RTS $(PROFRTSFLAGS) -RTS
|
|
mv hledgerp.prof profs/$(TIME).prof
|
|
(cd profs; rm -f latest*.prof; ln -s $(TIME).prof latest.prof)
|
|
|
|
# generate, archive, simplify and display an execution profile
|
|
viewprof: prof
|
|
tools/simplifyprof.hs profs/latest.prof
|
|
|
|
# generate and display an execution profile, don't save or simplify
|
|
quickprof: samplejournals bin/hledgerp
|
|
@echo "Profiling: $(PROFCMD)"
|
|
-$(PROFCMD) +RTS $(PROFRTSFLAGS) -RTS
|
|
echo; cat hledgerp.prof
|
|
|
|
# generate and archive a graphical heap profile
|
|
heap: samplejournals bin/hledgerp
|
|
@echo "Profiling heap with: $(PROFCMD)"
|
|
$(PROFCMD) +RTS -hc -RTS
|
|
mv hledgerp.hp profs/$(TIME).hp
|
|
(cd 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
|
|
$(VIEWPS) profs/latest.ps
|
|
|
|
# generate and display a graphical heap profile, don't save
|
|
quickheap: samplejournals bin/hledgerp
|
|
@echo "Profiling heap with: $(PROFCMD)"
|
|
$(PROFCMD) +RTS -hc -RTS
|
|
hp2ps hledgerp.hp
|
|
$(VIEWPS) hledger.ps
|
|
|
|
# display a code coverage text report from running hledger COVCMD
|
|
quickcoverage:
|
|
@echo "Generating code coverage text report for hledger command: $(COVCMD)"
|
|
tools/runhledgerhpc "report" $(COVCMD)
|
|
|
|
# generate a code coverage html report from running hledger COVCMD
|
|
coverage: samplejournals hledgerhpc
|
|
@echo "Generating code coverage html report for hledger command: $(COVCMD)"
|
|
tools/runhledgerhpc "markup --destdir=profs/coverage" $(COVCMD)
|
|
cd profs/coverage; rm -f index.html; ln -s hpc_index.html index.html
|
|
|
|
# view the last html code coverage report
|
|
viewcoverage:
|
|
$(VIEWHTML) profs/coverage/index.html
|
|
|
|
# get a debug prompt
|
|
ghci:
|
|
ghci $(INCLUDEPATHS) $(MAIN)
|
|
|
|
ghci-vty:
|
|
ghci $(INCLUDEPATHS) hledger-vty/Hledger/Vty/Main.hs
|
|
|
|
# generate standard sample journals
|
|
samplejournals: data/sample.journal data/100x100x10.journal data/1000x1000x10.journal data/10000x1000x10.journal data/100000x1000x10.journal
|
|
|
|
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/10000x1000x10.journal: tools/generatejournal
|
|
tools/generatejournal 10000 1000 10 >$@
|
|
|
|
data/100000x1000x10.journal: tools/generatejournal
|
|
tools/generatejournal 100000 1000 10 >$@
|
|
|
|
######################################################################
|
|
# DOCUMENTATION
|
|
|
|
# Documentation source files are UPPERCASE files in the top directory.
|
|
# site/ contains both html generated from these (UPPERCASE.html) and
|
|
# revision-controlled resource files (everything else). site/api
|
|
# contains only generated files.
|
|
|
|
cleandocs:
|
|
rm -rf site/[A-Z]*.html site/api/*
|
|
|
|
# rebuild all docs
|
|
docs: site codedocs
|
|
|
|
# build the hledger.org website
|
|
# Requires hakyll (cabal install hakyll)
|
|
.PHONY: site
|
|
site: site/site
|
|
cd site; ./site build
|
|
|
|
cleansite: site/site
|
|
cd site; ./site clean
|
|
|
|
previewsite: site/site
|
|
cd site; ./site preview
|
|
|
|
site/site: site/site.hs
|
|
cd site; ghc --make site.hs $(PREFERMACUSRLIBFLAGS)
|
|
|
|
autosite:
|
|
cd site; $(AUTOBUILD) site.hs -o site $(PREFERMACUSRLIBFLAGS) --run preview
|
|
|
|
viewsite: site
|
|
$(VIEWHTML) site/_site/index.html
|
|
|
|
# called on each darcs commit
|
|
commithook: docs
|
|
|
|
# generate html versions of docs (and the hledger.org website)
|
|
# work around pandoc not handling full rst image directive
|
|
# html:
|
|
# for d in $(DOCFILES); do $(PANDOC) --toc -s -H site/header.html -A site/footer.html -r rst $$d >site/$$d.html; done
|
|
# cd site && ln -sf ../SCREENSHOTS && $(RST2HTML) SCREENSHOTS >SCREENSHOTS.html && rm -f SCREENSHOTS
|
|
# cd site; rm -f index.html; ln -s README.html index.html; rm -f profs; ln -s ../profs
|
|
|
|
|
|
pdf: docspdf codepdf
|
|
|
|
# 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,NEWS,CONTRIBUTORS,SCREENSHOTS}.pdf code.pdf
|
|
viewall: pdf
|
|
$(VIEWPDF) $(PDFS)
|
|
|
|
# print all docs and code for offline reading
|
|
printall: pdf
|
|
$(PRINT) $(PDFS)
|
|
|
|
# push latest docs etc. and update the hledger.org site
|
|
pushdocs: push
|
|
ssh simon@joyful.com 'make -C/repos/hledger docs'
|
|
|
|
# dump all executables' command line help into files for review
|
|
EXES=hledger hledger-vty hledger-web hledger-chart
|
|
savehelp:
|
|
for e in $(EXES); do $$e --help >.HELP_$$e; done
|
|
|
|
# generate api & other code docs
|
|
codedocs: haddock hscolour coverage #sourcegraph #hoogle
|
|
|
|
#http://www.haskell.org/haddock/doc/html/invoking.html
|
|
#$(subst -D,--optghc=-D,$(DEFINEFLAGS))
|
|
HADDOCK=haddock --no-warnings --prologue .haddockprologue #--optghc='-hide-package monads-tf'
|
|
|
|
.haddocksynopsis: hledger/hledger.cabal
|
|
grep synopsis $< | sed -e 's/synopsis: *//' >$@
|
|
|
|
.haddockprologue: 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" >>$@
|
|
|
|
# generate api docs for the whole project
|
|
# we define HADDOCK to disable cabal-file-th code which requires a cabal file in the current dir
|
|
haddock: .haddockprologue
|
|
$(HADDOCK) --title "hledger-* API docs" \
|
|
-o site/api \
|
|
--html \
|
|
--source-module=src/%{MODULE/./-}.html \
|
|
--source-entity=src/%{MODULE/./-}.html#%N \
|
|
$(HADDOCKSOURCEFILES)
|
|
|
|
# browse the api docs
|
|
viewhaddock:
|
|
$(VIEWHTML) site/api/frames.html
|
|
|
|
# http://www.cs.york.ac.uk/fp/darcs/hscolour/
|
|
HSCOLOUR=HsColour -css
|
|
hscolour: site/api/src site/api/src/hscolour.css
|
|
for f in $(HADDOCKSOURCEFILES); do \
|
|
$(HSCOLOUR) -anchor $$f -osite/api/src/`echo $$f | sed -e's%[^/]*/%%' | sed -e's%/%-%g' | sed -e's%\.hs$$%.html%'` ; \
|
|
done
|
|
|
|
site/api/src/hscolour.css: site/api/src
|
|
$(HSCOLOUR) -print-css >site/api/src/hscolour.css
|
|
|
|
site/api/src:
|
|
mkdir -p site/api/src
|
|
|
|
sourcegraph:
|
|
for p in $(PACKAGES); do (cd $$p; SourceGraph $$p.cabal); done
|
|
|
|
patchdeps:
|
|
darcs2dot > patchdeps.dot && dot -Tpng -O patchdeps.dot
|
|
|
|
# # generate external api docs for each package
|
|
# allhaddock: allcabalhaddock\ --hyperlink-source\ --executables
|
|
|
|
# # generate internal code docs for each package
|
|
# allhaddockinternal: allcabalhaddock\ --hyperlink-source\ --executables\ --internal
|
|
|
|
# # generate hoogle indices for each package
|
|
# allhoogle: allcabalhaddock\ --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
|
|
# hoogleindex:
|
|
# $(HADDOCK) -o site/api --hoogle $(MAIN) && \
|
|
# cd site/api && \
|
|
# hoogle --convert=main.txt --output=default.hoo
|
|
|
|
######################################################################
|
|
# RELEASING
|
|
|
|
# Version numbering. See also VERSION and Version.hs.
|
|
#
|
|
# hledger's version number appears in:
|
|
# hledger --version
|
|
# hledger's cabal file
|
|
# darcs tags
|
|
# hackage tarball filenames
|
|
# hackage pages
|
|
#
|
|
# Some old version numbering goals:
|
|
# 1 automation, robustness, simplicity, platform independence
|
|
# 2 cabal versions must be all-numeric
|
|
# 3 release versions can be concise (without extra .0's)
|
|
# 4 releases should have a corresponding darcs tag
|
|
# 5 development builds should have a precise version appearing in --version
|
|
# 6 development builds should generate cabal packages with non-confusing versions
|
|
# 7 there should be a way to mark builds/releases as alpha or beta
|
|
# 8 it should be easy to darcs get the .0 release even after bugfix releases
|
|
# 9 avoid unnecessary compiling and linking
|
|
# 10 minimise rcs noise and syncing issues (commits, unrecorded changes)
|
|
#
|
|
# Current policy:
|
|
#
|
|
# - We follow http://haskell.org/haskellwiki/Package_versioning_policy
|
|
#
|
|
# - The full release version is ma.jor.minor, where minor is 0 for a
|
|
# normal release or 1..n for bugfix releases.
|
|
#
|
|
# - The elided release version is ma.jor when minor is 0. We use it for
|
|
# hackage releases when possible, trusting it doesn't cause trouble..
|
|
#
|
|
# - The build version is ma.jor.minor+patches, where patches is the number
|
|
# of patches applied in the current repo since the last release tag.
|
|
#
|
|
# - The release tag in the repo is the full release version.
|
|
#
|
|
# - hledger --version shows the release version or build version as
|
|
# appropriate.
|
|
#
|
|
# - The VERSION file must be updated manually before a release.
|
|
#
|
|
# - "make simplebench" depends on version numbers in BENCHEXES, these also
|
|
# must be updated manually.
|
|
#
|
|
# - "make" updates the version in most other places, and defines PATCHES.
|
|
# Note "cabal build" should also do this but doesn't yet.
|
|
#
|
|
# - "make release" additionally records the main version number-affected
|
|
# files, and tags the repo with the release tag.
|
|
|
|
# Build a release, tag the repo, prepare a cabal package
|
|
# First update VERSION. Eg:
|
|
# a normal release: echo 0.7 >VERSION; make release
|
|
# a bugfix release: echo 0.7.1 >VERSION; make release
|
|
release: releasetest setandrecordversion tagrelease
|
|
|
|
# Upload the latest cabal package and update hledger.org
|
|
upload: allcabalsdist hackageupload pushdocs
|
|
|
|
releaseandupload: release upload
|
|
|
|
|
|
# update the version number in local files, and prompt to record changes
|
|
# in these files. Triggered by "make release".
|
|
setandrecordversion: setversion
|
|
darcs record -m "bump version" $(VERSIONFILE) $(VERSIONSENSITIVEFILES)
|
|
|
|
# update the version string in local files. This should be run immediately
|
|
# after editing the VERSION file.
|
|
setversion: $(VERSIONSENSITIVEFILES)
|
|
|
|
# re-update version string even if it seems unchanged
|
|
Setversion:
|
|
touch $(VERSIONFILE); make setversion
|
|
|
|
hledger-lib/hledger-lib.cabal: $(VERSIONFILE)
|
|
perl -p -e "s/(^ *version:) *.*/\1 $(VERSION)/" -i $@
|
|
|
|
hledger/hledger.cabal: $(VERSIONFILE)
|
|
perl -p -e "s/(^ *version:) *.*/\1 $(VERSION)/" -i $@
|
|
perl -p -e "s/(^[ ,]*hledger-lib *[>=]=) *.*/\1 $(VERSION)/" -i $@
|
|
|
|
hledger-chart/hledger-chart.cabal: $(VERSIONFILE)
|
|
perl -p -e "s/(^ *version:) *.*/\1 $(VERSION)/" -i $@
|
|
perl -p -e "s/(^[ ,]*hledger *[>=]=) *.*/\1 $(VERSION)/" -i $@
|
|
perl -p -e "s/(^[ ,]*hledger-lib *[>=]=) *.*/\1 $(VERSION)/" -i $@
|
|
|
|
hledger-vty/hledger-vty.cabal: $(VERSIONFILE)
|
|
perl -p -e "s/(^ *version:) *.*/\1 $(VERSION)/" -i $@
|
|
perl -p -e "s/(^[ ,]*hledger *[>=]=) *.*/\1 $(VERSION)/" -i $@
|
|
perl -p -e "s/(^[ ,]*hledger-lib *[>=]=) *.*/\1 $(VERSION)/" -i $@
|
|
|
|
hledger-web/hledger-web.cabal: $(VERSIONFILE)
|
|
perl -p -e "s/(^ *version:) *.*/\1 $(VERSION)/" -i $@
|
|
perl -p -e "s/(^[ ,]*hledger *[>=]=) *.*/\1 $(VERSION)/" -i $@
|
|
perl -p -e "s/(^[ ,]*hledger-lib *[>=]=) *.*/\1 $(VERSION)/" -i $@
|
|
|
|
MANUAL.md: $(VERSIONFILE)
|
|
perl -p -e "s/(^This is the.*?manual.*? for hledger.*?) +[0-9.]+/\1 $(VERSION)./" -i $@
|
|
|
|
DOWNLOAD.md: $(VERSIONFILE)
|
|
perl -p -e "s/hledger(|-chart|-web|-vty)-[0-9.]+-/hledger\1-$(VERSION)-/g" -i $@
|
|
|
|
tagrelease:
|
|
darcs tag $(VERSION)
|
|
|
|
# display a hackage upload command reminder
|
|
hackageupload:
|
|
for p in $(PACKAGES); do cabal upload $$p/dist/$$p-$(VERSION).tar.gz -v3; done
|
|
|
|
# send unpushed patches to the mail list
|
|
send:
|
|
darcs send http://joyful.com/repos/hledger --to=hledger@googlegroups.com --edit-description
|
|
|
|
# push patches and anything else pending to the public server
|
|
push: pushprofs # pushlatestbinary
|
|
darcs push simon@joyful.com:/repos/hledger
|
|
|
|
# pull anything pending from the public server
|
|
pull: pullprofs
|
|
darcs pull -a simon@joyful.com:/repos/hledger
|
|
|
|
# push any new profiles and benchmark results to the public site
|
|
# beware, results will vary depending on which machine generated them
|
|
pushprofs:
|
|
rsync -azP profs/ simon@joyful.com:/repos/hledger/profs/
|
|
|
|
# fetch any new profiles and benchmark results from the public site
|
|
pullprofs:
|
|
rsync -azP simon@joyful.com:/repos/hledger/profs/ profs/
|
|
|
|
# compress the just-built platform binary. make hledgerPLATFORM first. Use
|
|
# the win variant on windows.
|
|
compressbinary:
|
|
gzip -9 bin/$(BINARYFILENAME)
|
|
compressbinarywin:
|
|
cd bin; zip -9 $(BINARYFILENAME).zip $(BINARYFILENAME)
|
|
|
|
# push the last-updated platform binary to the public download directory
|
|
pushlatestbinary:
|
|
cd bin; rsync -aP `ls -t | head -1` simon@joyful.com:/repos/hledger/site/download/
|
|
|
|
|
|
# show project stats useful for release notes
|
|
showreleasestats stats: \
|
|
showreleasedays \
|
|
showunreleasedchangecount \
|
|
showloc \
|
|
showtestcount \
|
|
showunittestcoverage \
|
|
showreleaseauthors \
|
|
showunreleasedcodechanges \
|
|
showunpushedchanges
|
|
# simplebench
|
|
# showerrors
|
|
|
|
FROMTAG=.
|
|
|
|
showreleasedays:
|
|
@echo Days since last release:
|
|
@tools/dayssincetag.hs $(FROMTAG) | head -1 | cut -d' ' -f-1
|
|
@echo
|
|
|
|
showunreleasedchangecount:
|
|
@echo Commits since last release:
|
|
@darcs changes --from-tag $(FROMTAG) --count
|
|
@echo
|
|
|
|
showreleaseauthors:
|
|
@echo Patch authors since last release:
|
|
@darcs changes --from-tag $(FROMTAG) |grep '^\w' |cut -c 31- |sort |uniq
|
|
@echo
|
|
|
|
showloc sloccount:
|
|
@echo Current lines of code including tests:
|
|
@sloccount `ls $(SOURCEFILES)` | grep haskell:
|
|
@echo
|
|
|
|
showtestcount:
|
|
@echo "Unit tests:"
|
|
@hledger test 2>&1 | cut -d' ' -f2
|
|
@echo "Functional tests:"
|
|
@make --no-print functest | egrep '^ Total' | awk '{print $$2}'
|
|
@echo
|
|
|
|
showunittestcoverage:
|
|
@echo Unit test coverage:
|
|
@make --no-print quickcoverage | grep 'expressions'
|
|
@echo
|
|
|
|
# showerrors:
|
|
# @echo Known errors:
|
|
# @awk '/^** errors/, /^** / && !/^** errors/' NOTES.org | grep '^\*\*\* ' | tail +1
|
|
# @echo
|
|
|
|
showunpushedchanges unpushed:
|
|
@echo "Changes not yet pushed upstream (to `darcs show repo | grep 'Default Remote' | cut -c 17-`):"
|
|
@-darcs push simon@joyful.com:/repos/hledger --dry-run | grep '*' | tac
|
|
@echo
|
|
|
|
showunreleasedcodechanges unreleased:
|
|
@echo "hledger code changes since last release:"
|
|
@darcs changes --from-tag $(FROMTAG) --matches "not (name docs: or name doc: or name site: or name tools:)" | grep '*'
|
|
@echo
|
|
|
|
showcodechanges:
|
|
@echo "hledger code changes:"
|
|
@darcs changes --matches "not (name docs: or name site: or name tools:)" | egrep '^ +(\*|tagged)'
|
|
@echo
|
|
|
|
######################################################################
|
|
# MISCELLANEOUS
|
|
|
|
# fix permissions (eg after darcs get)
|
|
fixperms:
|
|
chmod +x tools/* $(MAIN) hledger-*/Main.hs
|
|
|
|
tag: emacstags
|
|
|
|
emacstags:
|
|
-@rm -f TAGS; hasktags -e $(SOURCEFILES) $(WEBFILES) $(CABALFILES) $(DOCFILES) Makefile
|
|
|
|
clean:
|
|
rm -rf `find . -name "*.o" -o -name "*.hi" -o -name "*~" -o -name "darcs-amend-record*" -o -name "*-darcs-backup*" | grep -v .virthualenv`
|
|
|
|
cleanbin:
|
|
rm -f bin/hledger bin/hledger.ghc*
|
|
|
|
Clean: clean cleanbin cleandocs
|
|
rm -f TAGS tags
|
|
|