# hledger project makefile # ghc 6.12 executables need a locale export LANG=en_US.UTF-8 # optional features described in MANUAL, comment out if you don't have the libs OPTFLAGS=-DWEB -DVTY -DCHART OPTFLAGS=-DWEB -DVTY #OPTFLAGS=-DWEB #OPTFLAGS= # command to run during "make ci" CICMD=web --debug -f ~/personal/current.journal # -f data/sample.journal CICMD=test #CICMD=-f t.journal print # command line to run during "make prof" and "make heap" PROFCMD=bin/hledgerp -f data/1000x1000x10.journal balance >/dev/null # 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.9 hledger-0.10-1 hledgeropt ledger #BENCHEXES=hledger # misc. tools RST2PDF=rst2pdf #VIEWHTML=open -a 'Google Chrome' VIEWHTML=google-chrome VIEWPS=open VIEWPDF=open PRINT=lpr MAIN=hledger.hs SOURCEFILES:= \ $(MAIN) \ [A-Z]*hs \ Hledger/Cli/*hs \ Hledger/Cli/Commands/*hs \ hledger-lib/*hs \ hledger-lib/Hledger/*hs \ hledger-lib/Hledger/Data/*hs \ hledger-lib/Hledger/Read/*hs DOCFILES:=README README2 MANUAL NEWS CONTRIBUTORS SCREENSHOTS BINARYFILENAME=`runhaskell ./hledger.hs --binary-filename` PATCHLEVEL:=$(shell expr `darcs changes --count --from-tag=\\\\\.` - 1) WARNINGS:=-W -fwarn-tabs #-fwarn-orphans -fwarn-simple-patterns -fwarn-monomorphism-restriction -fwarn-name-shadowing DEFINEFLAGS:=-DMAKE -DPATCHLEVEL=$(PATCHLEVEL) $(OPTFLAGS) PREFERMACUSRLIBFLAGS=-L/usr/lib BUILDFLAGS:=$(PREFERMACUSRLIBFLAGS) $(DEFINEFLAGS) $(WARNINGS) -ihledger-lib TIME:=$(shell date +"%Y%m%d%H%M") # 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=\ hledger.cabal \ Hledger/Cli/Version.hs \ hledger-lib/hledger-lib.cabal \ MANUAL.markdown \ DOWNLOAD.markdown \ default: tag hledger ###################################################################### # BUILDING # fetch dependencies, build and install the standard cabal binary hledgercabal: cd hledger-lib; cabal install cabal install -fweb -fvty # build the standard developer's binary, quickly hledger: setversion ghc --make hledger.hs -o bin/hledger $(BUILDFLAGS) # -O hledgernowarnings: setversion ghc --make hledger.hs -o bin/hledger $(BUILDFLAGS) -Werror -v0 # build the profiling-enabled binary. You may need to cabal install # --reinstall -p some libs. hledgerp: setversion ghc --make hledger.hs -prof -auto-all -o bin/hledgerp $(BUILDFLAGS) # build the coverage-enabled binary. coverage-enabled .o files are kept # separate to avoid contamination. hledgercov: setversion ghc --make hledger.hs -fhpc -o bin/hledgercov -outputdir .coverageobjs $(BUILDFLAGS) # build the fastest binary we can hledgeropt: setversion ghc --make hledger.hs -o bin/hledgeropt $(BUILDFLAGS) -O2 # -fvia-C # -fexcess-precision -optc-O3 -optc-ffast-math # build a deployable binary for mac, one which uses only standard osx libs hledgermac: setversion ghc --make hledger.hs -o bin/$(BINARYFILENAME) $(BUILDFLAGS) -O2 # -optl-L/usr/lib @echo Please check the build looks portable: otool -L bin/$(BINARYFILENAME) # build a deployable binary for gnu/linux, statically linked hledgerlinux: setversion ghc --make hledger.hs -o bin/$(BINARYFILENAME) $(BUILDFLAGS) -O2 -static -optl-static -optl-pthread @echo Please check the build looks portable (static): -file bin/$(BINARYFILENAME) # build a deployable binary for windows, using cygwin presumably # hledgerwin: setversion # ghc --make hledger.hs -o bin/hledgerlinux $(BUILDFLAGS) -O2 -static -optl-static -optl-pthread # auto-recompile and run (with the specified argument) whenever a module changes. # sp is from searchpath.org, you might need the patched version from # http://joyful.com/repos/searchpath. auto-%: setversion sp --no-exts --no-default-map -o bin/hledger ghc --make hledger.hs $(BUILDFLAGS) --run $* autobuild auto: auto-test # fix permissions (eg after darcs get) fixperms: chmod +x hledger.hs tools/* # 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 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 releasetest: unittest doctest functest warningstest fullcabaltest haddocktest hlinttest hlint: hlint --hint=hlint --report=hlint.html $(SOURCEFILES) # run unit tests unittest: unittest-builtin unittest-builtin: hledger @(bin/hledger test \ && echo $@ PASSED) || echo $@ FAILED # XXX doesn't rebuild on hledger source changes unittest-standalone: tools/unittest @(tools/unittest \ && echo $@ PASSED) || echo $@ FAILED # run unit tests without waiting for compilation unittesths: @(runghc hledger.hs 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: hledger (shelltest tests --implicit=none --plain --threads=16 \ && echo $@ PASSED) || echo $@ FAILED # run doc tests doctest: tools/doctest hledger @(tools/doctest Hledger/Cli/Commands/Add.hs \ && tools/doctest Hledger/Cli/Tests.hs \ && echo $@ PASSED) || echo $@ FAILED # make sure we have no haddock errors haddocktest: @(make --quiet haddock \ && echo $@ PASSED) || echo $@ FAILED # 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: setversion (cd hledger-lib \ && cabal clean \ && cabal check \ && cabal configure \ && cd .. \ && cabal clean \ && cabal check \ && cabal configure -fvty -fweb \ && echo $@ PASSED) || echo $@ FAILED # make sure cabal is happy in all possible ways fullcabaltest: setversion (cd hledger-lib \ && cabal clean \ && cabal check \ && cabal install \ && cabal sdist \ && cabal upload dist/hledger-lib-$(VERSION).tar.gz --check -v3 \ && cd .. \ && cabal clean \ && cabal check \ && cabal configure -fvty -fweb \ && cabal build \ && dist/build/hledger/hledger test 2>&1 | tail -1 | grep -q 'Errors: 0 Failures: 0' \ && cabal sdist \ && cabal upload dist/hledger-$(VERSION).tar.gz --check -v3 \ && echo $@ PASSED \ ) || echo $@ FAILED # run 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 performance benchmarks and save textual results in profs/. # 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, save, simplify and display an execution profile prof: samplejournals hledgerp @echo "Profiling: $(PROFCMD)" -$(PROFCMD) +RTS -p -RTS mv hledgerp.prof profs/$(TIME)-orig.prof tools/simplifyprof.hs profs/$(TIME)-orig.prof >profs/$(TIME).prof (cd profs; rm -f latest*.prof; ln -s $(TIME)-orig.prof latest-orig.prof; ln -s $(TIME).prof latest.prof) echo; cat profs/latest.prof # generate and display an execution profile, don't save or simplify quickprof: samplejournals hledgerp @echo "Profiling: $(PROFCMD)" -$(PROFCMD) +RTS -p -RTS echo; cat hledgerp.prof # generate, save and display a graphical heap profile heap: samplejournals 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) $(VIEWPS) profs/latest.ps # generate and display a graphical heap profile, don't save quickheap: samplejournals hledgerp @echo "Profiling heap with: $(PROFCMD)" $(PROFCMD) +RTS -hc -RTS hp2ps hledgerp.hp $(VIEWPS) hledger.ps # generate and display a code coverage report coverage: samplejournals hledgercov @echo "Generating coverage report with $(COVCMD)" tools/coverage "markup --destdir=profs/coverage" test cd profs/coverage; rm -f index.html; ln -s hpc_index.html index.html $(VIEWHTML) profs/coverage/index.html # get a debug prompt ghci: ghci -DMAKE $(OPTFLAGS) hledger.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-doc # contains only generated files. cleandocs: rm -rf site/[A-Z]*.html site/api-doc/* # rebuild all docs docs: site apidocs # build the hledger.org website # Requires hakyll (cabal install hakyll) .PHONY: site site: site/hakyll site/_site/index.html site/_site/profs cd site; ./hakyll build site/_site/index.html: cd site/_site; ln -sf README.html index.html; ln -sf ../../profs site/_site/profs: cd site/_site; ln -sf ../../profs cleansite: site/hakyll cd site; ./hakyll clean previewsite: site/hakyll cd site; ./hakyll preview site/hakyll: site/hakyll.hs cd site; ghc --make hakyll.hs $(PREFERMACUSRLIBFLAGS) siteci: cd site; sp --no-exts --no-default-map -o hakyll ghc --make hakyll.hs $(PREFERMACUSRLIBFLAGS) --run preview viewsite: site $(VIEWHTML) site/_site/index.html # called on each darcs commit commithook: site # 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 # work around rst2pdf needing images in the same directory docspdf: -for d in $(DOCFILES); do (cd site && ln -sf ../$$d && $(RST2PDF) $$d && rm -f $$d); done # format all code as a pdf for offline reading ENSCRIPT=enscript -q --header='$$n|$$D{%+}|Page $$% of $$=' --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 joyful.com 'make -C/repos/hledger docs' # generate api docs # 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: ? apidocs: haddock hscolour #sourcegraph #hoogle sed -i -e 's%^>site/api-doc/hscolour.css sourcegraph: -SourceGraph hledger.cabal -cd hledger-lib; SourceGraph hledger-lib.cabal #set up the hoogle web interface #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-doc && \ 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-doc --hoogle $(MAIN) && \ cd site/api-doc && \ 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 # Don't forget to update VERSION first. Examples: # normal release: echo 0.7 >VERSION; make release # a bugfix release: echo 0.7.1 >VERSION; make release release: releasetest setandrecordversion tagrelease sdist # Upload the latest cabal package and update hledger.org upload: 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. Triggered by "make". setversion: $(VERSIONSENSITIVEFILES) Hledger/Cli/Version.hs: $(VERSIONFILE) perl -p -e "s/(^version *= *)\".*?\"/\1\"$(VERSION3)\"/" -i $@ # XXX also touch manually when switching between cabal install -fweb and -fweb610 hledger.cabal: $(VERSIONFILE) perl -p -e "s/(^ *version:) *.*/\1 $(VERSION)/" -i $@ perl -p -e "s/(^ *hledger-lib *[>=]=) *.*/\1 $(VERSION)/" -i $@ hledger-lib/hledger-lib.cabal: $(VERSIONFILE) perl -p -e "s/(^ *version:) *.*/\1 $(VERSION)/" -i $@ MANUAL.markdown: $(VERSIONFILE) perl -p -e "s/(^This is the official.*?version) +[0-9.]+/\1 $(VERSION3)./" -i $@ DOWNLOAD.markdown: $(VERSIONFILE) perl -p -e "s/hledger-[0-9.]+-/hledger-$(VERSION3)-/g" -i $@ tagrelease: darcs tag $(VERSION3) sdist: cd hledger-lib; cabal sdist cabal sdist # display a hackage upload command reminder hackageupload: cabal upload hledger-lib/dist/hledger-lib-$(VERSION).tar.gz -v3 cabal upload dist/hledger-$(VERSION).tar.gz -v3 # 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 pushbinary darcs push joyful.com:/repos/hledger # pull anything pending from the public server pull: pullprofs darcs pull -a 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/ joyful.com:/repos/hledger/profs/ # fetch any new profiles and benchmark results from the public site pullprofs: rsync -azP joyful.com:/repos/hledger/profs/ profs/ # push a deployable binary for this platform to the public site # make hledgerPLATFORM first pushbinary: -gzip -9 bin/$(BINARYFILENAME) -rsync -aP bin/$(BINARYFILENAME).gz joyful.com:/repos/hledger/site/binaries/ # show project stats useful for release notes stats: showlastreleasedate showreleaseauthors showloc showcov showlocalchanges showreleasechanges #simplebench #showerrors showreleaseauthors: @echo Patch authors since last release: @darcs changes --from-tag . |grep '^\w' |cut -c 31- |sort |uniq @echo showloc: @echo Lines of code including tests: @sloccount `ls $(SOURCEFILES)` | grep haskell: @echo showcov: hledgercov @echo Test coverage: @tools/coverage report test showlastreleasedate: @echo Last release date: @darcs changes --from-tag . | tail -2 @echo # showerrors: # @echo Known errors: # @awk '/^** errors/, /^** / && !/^** errors/' NOTES | grep '^\*\*\* ' | tail +1 # @echo showlocalchanges: @echo Local changes: @-darcs push joyful.com:/repos/hledger --dry-run | grep '*' | tac @echo showcodechanges: @echo Code changes: @darcs changes --matches "not (name docs: or name site: or name tools:)" | egrep '^ +(\*|tagged)' @echo showreleasechanges: @echo "Feature/bugfix changes since last release: ("`darcs changes --from-tag . --count`")" @darcs changes --from-tag . --matches "not (name docs: or name doc: or name site: or name tools:)" | grep '*' @echo ###################################################################### # MISCELLANEOUS #LOCAL # deploy latest build at demo.hledger.org deploy: ssh -t simon@joyful.com make -C /repos/hledger deploy # autobuild web ui showing my personal journal autowebmine: sp --no-exts --no-default-map -o bin/hledger ghc --make hledger.hs $(BUILDFLAGS) -DWEB --run web -B -f ~/personal/2010.journal # tag: emacstags emacstags: -@rm -f TAGS; hasktags -e $(SOURCEFILES) hledger.cabal Makefile clean: rm -rf `find . -name "*.o" -o -name "*.hi" -o -name "*~" -o -name "darcs-amend-record*" -o -name "*-darcs-backup*"` Clean: clean cleandocs rm -f bin/hledger TAGS tags