# hledger project makefile TIME=`date +"%Y%m%d%H%M"` # patches since last release tag (as a haskell string literal) PATCHES:=$(shell expr `darcs changes --count --from-tag=\\\\\.` - 1) # optional flags described in README, turn em on if you've got the libs OPTFLAGS=-DHAPPS -DVTY BUILDFLAGS=-DPATCHES=$(PATCHES) $(OPTFLAGS) default: tag hledger ###################################################################### # BUILDING, DEBUGGING # build the standard developer's binary, quickly hledger: setversion ghc --make hledger.hs -o hledger $(BUILDFLAGS) # -O # 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 hledgerp #$(BUILDFLAGS) # build the fastest binary we can hledgeropt: setversion ghc --make hledger.hs -o hledgeropt -O2 -fvia-C $(BUILDFLAGS) # "continuous integration" testing - auto-recompile and run hledger test # (or some other command) whenever a module changes. sp is from # searchpath.org , you might need the patched version from # http://joyful.com/repos/searchpath . #CICMD=web --debug -BE CICMD=test continuous ci: setversion sp --no-exts --no-default-map -o hledger ghc --make hledger.hs $(BUILDFLAGS) --run $(CICMD) # build the benchmark runner. Requires tabular from hackage. bench: ghc --make tools/bench.hs # build the doctest runner tools/doctest: tools/doctest.hs ghc --make tools/doctest.hs # build the generateledger tool generateledger: tools/generateledger.hs ghc --make tools/generateledger.hs # get a debug prompt ghci: ghci hledger.hs # generate a standard profile, archive in profs/ and display PROFCMD=-f 1000x1000x10.ledger balance prof: sampleledgers hledgerp @echo "Profiling $(PROFCMD)" ./hledgerp +RTS -p -RTS $(PROFCMD) >/dev/null mv hledgerp.prof profs/$(TIME).prof tools/simplifyprof.hs profs/$(TIME).prof >profs/$(TIME)-cleaned.prof echo; cat profs/$(TIME)-cleaned.prof ###################################################################### # TESTING # run all tests test: unittest doctest haddocktest # run unit tests, without waiting for compilation unittest: runghc hledger.hs test # run doc tests doctest: tools/doctest @tools/doctest AddCommand.hs @tools/doctest Tests.hs # make sure we have no haddock errors haddocktest: @make --quiet haddock # run performance tests and save results in profs/. # Requires some tests defined in bench.tests and some executables defined below. # Prepend ./ to these if not in $PATH. BENCHEXES=hledger-0.4 hledger-0.5 ledger benchtest: sampleledgers bench.tests bench tools/bench $(BENCHEXES) --verbose | tee profs/`date +%Y%m%d%H%M%S`.bench # generate standard sample ledgers sampleledgers: sample.ledger 100x100x10.ledger 1000x1000x10.ledger 10000x1000x10.ledger \ 100000x1000x10.ledger 1000.ledger 10000.ledger 100000.ledger 1000x1000x10.ledger sample.ledger: true # XXX should probably regenerate this 100x100x10.ledger: generateledger tools/generateledger 1000 1000 10 >$@ 1000x1000x10.ledger: generateledger tools/generateledger 1000 1000 10 >$@ 10000x1000x10.ledger: generateledger tools/generateledger 10000 1000 10 >$@ 100000x1000x10.ledger: generateledger tools/generateledger 100000 1000 10 >$@ # keep for next benchmark report.. 1000include.ledger: ghc -e 'putStr $$ unlines $$ replicate 1000 "!include sample.ledger"' >1000.ledger 10000include.ledger: ghc -e 'putStr $$ unlines $$ replicate 10000 "!include sample.ledger"' >10000.ledger 100000include.ledger: ghc -e 'putStr $$ unlines $$ replicate 100000 "!include sample.ledger"' >100000.ledger ###################################################################### # DOCS DOCS=HOME README NEWS CONTRIBUTORS SCREENSHOTS # rebuild all docs docs: html pdf api-docs buildwebsite: mkdir -p website -cp doc/*.png website for d in $(DOCS); do pandoc -r rst $$d >website/$$d.html; done (cd website; rm -f index.html; ln -s HOME.html index.html) # rebuild pdf docs pdf: for d in $(DOCS); do rst2pdf $$d -o doc/$$d.pdf; done # rebuild 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". api-docs: haddock hoogleweb echo "Converting api docs to frames" ; \ sed -i -e 's%^>api-doc/hscolour.css #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-/'` hoogleweb: hoogleindex echo "Configuring hoogle web interface" ; \ if test -f $(HOOGLE) ; then \ mkdir -p hoogle && \ cd hoogle && \ 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: $(MAIN) echo "Generating hoogle index" ; \ mkdir -p hoogle && \ $(HADDOCK) -o hoogle --hoogle $^ && \ cd hoogle && \ hoogle --convert=main.txt --output=default.hoo cleandocs: rm -rf api-doc hoogle ###################################################################### # RELEASING # Places where hledger's version number makes an appearance: # hledger --version # hledger's cabal file # darcs tags # hackage tarball filenames # hackage pages # # Goals and constraints for our version number system: # 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 plan: # - The release version looks like major.minor[.bugfix]. bugfix is 0 (and # may be elided) for a normal release, or 1..n for a bugfix release, or # 98 meaning an alpha for the forthcoming release, or 99 meaning a beta. # - The build version looks like major.minor.bugfix.patches, where patches # is the number of patches applied since the last release tag. # - Set the release version in VERSION before "make" or "make release". # - "make" updates version strings where needed, and defines PATCHES. # "make release" also records the version number changes and tags the # repo. (Todo: make cabal build set the version and PATCHES, also) # - hledger --version shows the build version # - The cabal package uses the release version # - The release tag is the non-elided release version. # run pre-release checks: cabal is happy, the code builds, tests pass.. check: setversion test cabal clean cabal check cabal configure -fvty -fhapps cabal build dist/build/hledger/hledger test 2>&1 | tail -1 | grep -q 'Errors: 0 Failures: 0' # Build a cabal release, tag the repo and maybe upload to hackage. # Don't forget to update VERSION if needed. Examples: # releasing 0.5: set VERSION to 0.5, make release hackageupload # doing a bugfix release: set VERSION to 0.5.1, make release hackageupload # building 0.6 alpha: set VERSION to 0.5.98, make # releasing 0.6 beta: set VERSION to 0.5.99, make release release: check setandrecordversion tagrelease sdist # file where the current release version is defined VERSIONFILE=VERSION # two or three-part version string VERSION:=`grep -v '^--' $(VERSIONFILE)` # three-part version string ifeq ($(shell ghc -e "length (filter (=='.') \"$(VERSION)\")"), 1) VERSION3:=$(VERSION).0 else VERSION3:=$(VERSION) endif # other files containing the version string VERSIONFILES=hledger.cabal Version.hs hledger.cabal: $(VERSIONFILE) perl -p -e "s/(^version: *) .*/\1 $(VERSION)/" -i $@ Version.hs: $(VERSIONFILE) perl -p -e "s/(^version *= *)\".*?\"/\1\"$(VERSION3)\"/" -i $@ # update the version string in local files. Triggered by "make". setversion: $(VERSIONFILES) # update the version string in local files, and record them (and # $VERSIONFILE) if changed. Be careful, will record all changes in those # files (so prompts interactively). Triggered by "make release". setandrecordversion: setversion darcs record -m "bump version" $(VERSIONFILE) $(VERSIONFILES) tagrelease: darcs tag $(VERSION3) sdist: cabal sdist # display a hackage upload command reminder hackageupload: @echo please do: 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 to the main repo with ssh push: darcs push joyful.com:/repos/hledger # show project stats useful for release notes stats: showlastreleasedate showreleaseauthors showloc showerrors showlocalchanges showreleasechanges bench showreleaseauthors: @echo Patch authors since last release: @darcs changes --from-tag . |grep '^\w' |cut -c 31- |sort |uniq @echo showloc: @echo Lines of non-test code: @sloccount `ls {,Ledger/}*.hs |grep -v Tests.hs` | grep haskell: @echo Lines of test code: @sloccount Tests.hs | grep haskell: @echo 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 showreleasechanges: @echo "Changes since last release: ("`darcs changes --from-tag . --count`")" @darcs changes --from-tag . | grep '*' @echo ###################################################################### # MISCELLANEOUS tag: emacstags emacstags: @rm -f TAGS; hasktags -e *hs Ledger/*hs hledger.cabal clean: rm -f `find . -name "*.o" -o -name "*.hi" -o -name "*~" -o -name "darcs-amend-record*"` clean-docs: rm -rf website Clean: clean clean-docs rm -f hledger TAGS tags