hledger/Makefile

1154 lines
46 KiB
Makefile
Raw Normal View History

2016-10-28 21:15:10 +03:00
# One of two project scripts files (Makefile, Shake.hs).
2019-02-04 02:56:57 +03:00
# This one was a reboot of Makefile.old.
# It is probably used by hledger developers/contributors but not end-users.
2016-10-28 21:15:10 +03:00
# It requires GNU Make (https://www.gnu.org/software/make/).
# Also, some rules may require:
2016-10-28 21:15:10 +03:00
# - stack (http://haskell-lang.org/get-started, installs libs and runs ghc)
# - shelltestrunner (hackage, runs functional tests)
# - quickbench (hackage/stackage, runs benchmarks)
# - ghcid (hackage/stackage, recompiles and optionally runs tests on file change)
2016-10-28 21:15:10 +03:00
# - hasktags (hackage, generates tag files for code navigation)
# - profiterole (hackage/stackage, simplifies profiles)
2016-10-28 21:15:10 +03:00
# - profiteur (hackage/stackage, renders profiles as html)
# - hpack (hackage/stackage, generates cabal files from package.yaml files)
# - perl
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
#
# Kinds of hledger builds:
#
# - stack build: built with stack
# (hledger/.stack-work/dist/ARCH/CABAL/build/hledger/hledger,
# .stack-work/install/ARCH/SNAPSHOT/GHC/bin/hledger, installs to ~/.local/bin)
2019-02-04 02:56:57 +03:00
# - cabal (v1) build: built with cabal (and maybe a sandbox)
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
# (hledger/dist/build/hledger/hledger, installs to ~/.cabal/bin)
2019-02-04 02:56:57 +03:00
# - ghc-only build: built quickly with ghc only, unoptimised, with DEVELOPMENT flag
# (hledgerdev)
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
#
# This makefile mostly uses stack to get things done (slow but robust).
2019-02-04 02:56:57 +03:00
# It may sometimes (still ?) use ghc only, or cabal, when easier.
2020-08-08 22:07:06 +03:00
# see also: https://gmsl.sourceforge.io/
# XXX do we need this ?
#SHELL=/bin/bash
#.SHELLFLAGS="-O extglob -c" # example
2019-02-04 02:56:57 +03:00
###############################################################################
# MAKEFILE HELP SYSTEM
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
# This defines the def-help* functions for generating makefile help
# (see the file for more details), and a "help" target (our default).
# Every useful rule in this makefile should use def-help to describe itself.
# "make" or "make help" will show these descriptions.
-include Makefile.helpsys
# Some calls and dummy targets to augment the default help output.
# Also, help-SUBSTR and SUBSTR-help targets to show only matching help.
2019-02-04 02:56:57 +03:00
$(call def-help-heading,Main rules in the hledger project Makefile:)
$(call def-help-subheading,HELP:)
dummy1: $(call def-help,[help], list documented rules in this makefile )
help-%: $(call def-help,help-SECTION, list documented rules containing some string )
2020-07-10 19:28:46 +03:00
@make help 2>&1 | grep -i $*
%-help: $(call def-help,SECTION-help, same but easier to type (can append "-help" to any "make RULE") )
@make help 2>&1 | grep -i $*
2019-02-04 02:56:57 +03:00
dummy2: $(call def-help,RULE -n, show what RULE would do )
###############################################################################
# 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 profiling (time and heap)
PROFCMD=stack exec --profile -- hledger balance -f examples/10000x1000x10.journal >/dev/null
#PROFRTSFLAGS=-p
PROFRTSFLAGS=-P
# # command to run during "make coverage"
# COVCMD=test
# COVCMD=-f test-wf.csv print
# misc. system tools
BROWSE=open
# VIEWHTML=$(BROWSE)
VIEWPS=$(BROWSE)
# VIEWPDF=$(BROWSE)
# PRINT=lpr
2019-02-25 03:22:51 +03:00
#GHC=ghc
GHCI=ghci #-package ghc-datasize #-package ghc-heap-view
# GHCPKG=ghc-pkg
# HADDOCK=haddock
# CABAL=cabal
# CABALINSTALL=cabal install -w $(GHC)
# Which stack command (and in particular, stack yaml/GHC version) to use for building etc. ?
STACK ?= stack
#STACK=stack --stack-yaml=stack8.10.yaml
# Or override temporarily with an env var:
# STACK="stack --stack-yaml=stack8.10.yaml" make functest
# Which stack command (stack yaml, GHC version) to use for ghci[d] operations ?
STACKGHCI ?= $(STACK)
#STACKGHCI=stack --stack-yaml=stack9.2.yaml
# if using an unreleased stack with a newer hpack than the one mentioned in */*.cabal,
# it will give warnings. To silence these, put the old hpack-X.Y in $PATH and uncomment:
#STACK=stack --with-hpack=hpack-0.20
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
2021-01-05 02:28:09 +03:00
# --threads=16 sometimes gives "commitAndReleaseBuffer: resource vanished (Broken pipe)" but seems harmless
# --timeout=N is not much use here - can be defeated by multiple threads, unoptimised builds,
# slow hackage index or compiler setup on first build, etc.
SHELLTESTOPTS=--execdir --threads=64 --exclude=/_
# make sure shelltest is a released version of shelltestrunner
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
# run shell tests using the executable specified in tests
# SHELLTEST=COLUMNS=80 PATH=~/.local/bin:/usr/bin:/bin shelltest $(SHELLTESTOPTS)
# run shell tests using the stack build of hledger
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
#SHELLTESTSTK=shelltest -w `stack exec which hledger` $(SHELLTESTOPTS)
SHELLTESTSTK=COLUMNS=80 $(STACK) exec -- shelltest $(SHELLTESTOPTS)
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
2022-11-03 20:10:54 +03:00
WATCHEXEC=watchexec
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
PACKAGES=\
hledger-lib \
hledger \
hledger-ui \
2016-10-26 23:39:00 +03:00
hledger-web \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
2020-12-13 23:15:46 +03:00
BINARIES=\
hledger \
hledger-ui \
hledger-web \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
INCLUDEPATHS=\
-ihledger-lib \
-ihledger \
-ihledger-ui \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
-ihledger-web \
2016-10-26 23:39:00 +03:00
-ihledger-web/app \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
MAIN=hledger/app/hledger-cli.hs
# All source files in the project (plus a few strays like Setup.hs & hlint.hs).
# Used eg for building tags. Doesn't reliably catch all source files.
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
SOURCEFILES:= \
dev.hs \
hledger/*hs \
hledger/app/*hs \
hledger/bench/*hs \
hledger/test/*hs \
hledger/Hledger/*hs \
hledger/Hledger/*/*hs \
hledger/Hledger/*/*/*hs \
hledger-*/*hs \
hledger-*/app/*hs \
hledger-*/test/*hs \
hledger-*/Hledger/*hs \
hledger-*/Hledger/*/*hs \
hledger-*/Hledger/*/*/*hs \
hledger-lib/Text/*/*hs \
# hledger-*/src/*hs \
# show the sorted, unique files matched by SOURCEFILES
sourcefiles:
@for f in $(SOURCEFILES); do echo $$f; done | sort | uniq
# show the sorted, unique subdirectories containing hs files
sourcedirs:
@find . -name '*hs' | sed -e 's%[^/]*hs$$%%' | sort | uniq
HPACKFILES:= \
hledger/*package.yaml \
hledger-*/*package.yaml \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
CABALFILES:= \
hledger/hledger.cabal \
hledger-*/*.cabal \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
MANUALSOURCEFILES:= \
doc/common.m4 \
2017-12-07 05:16:35 +03:00
*/*.m4.md \
MANUALGENFILES:= \
2017-12-07 05:16:35 +03:00
hledger*/hledger*.{1,5,info,txt} \
COMMANDHELPFILES:= \
hledger/Hledger/Cli/Commands/*.md \
WEBTEMPLATEFILES:= \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
hledger-web/templates/* \
WEBCODEFILES:= \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
hledger-web/static/*.js \
hledger-web/static/*.css \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
DOCSOURCEFILES:= \
README.md \
CONTRIBUTING.md \
$(MANUALSOURCEFILES) \
$(COMMANDHELPFILES) \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
# # file(s) which require recompilation for a build to have an up-to-date version string
# VERSIONSOURCEFILE=hledger/Hledger/Cli/Version.hs
# Two or three-part version string, set as program version in builds made by this makefile.
# We use hledger CLI's current version (XXX for all packages, which isn't quite right).
VERSION=$(shell cat hledger/.version)
2022-03-26 21:11:52 +03:00
# Flags for ghc builds.
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
2022-03-26 21:11:52 +03:00
# Warnings to see during dev tasks like make ghci*. See also the warnings in package.yamls.
# XXX redundant with package.yamls ?
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
WARNINGS:=\
-Wall \
2022-03-26 21:11:52 +03:00
-Wno-incomplete-uni-patterns \
2022-03-26 09:28:34 +03:00
-Wno-missing-signatures \
-Wno-orphans \
-Wno-type-defaults \
2022-03-26 21:11:52 +03:00
-Wno-unused-do-bind \
2019-02-04 02:56:57 +03:00
# if you have need to try building in less memory
# GHCLOWMEMFLAGS= #+RTS -M200m -RTS
# ghc-only builds need the macro definitions generated by cabal
# from cabal's dist or dist-sandbox dir, hopefully there's just one:
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
#CABALMACROSFLAGS=-optP-include -optP hledger/dist*/build/autogen/cabal_macros.h
2019-02-04 02:56:57 +03:00
# or from stack's dist dir:
#CABALMACROSFLAGS=-optP-include -optP hledger/.stack-work/dist/*/*/build/autogen/cabal_macros.h
2019-02-18 06:50:59 +03:00
BUILDFLAGS=\
-rtsopts \
$(WARNINGS) \
$(INCLUDEPATHS) \
$(GHCLOWMEMFLAGS) $(CABALMACROSFLAGS) \
-DDEVELOPMENT \
-DVERSION="\"$(VERSION)\"" \
# -fplugin Debug.Breakpoint \
2019-02-18 06:50:59 +03:00
# -fhide-source-paths \
# PROFBUILDFLAGS:=-prof -fprof-auto -osuf hs_p
TIME=$(shell date +"%Y%m%d%H%M")
MONTHYEAR=$(shell date +'%B %Y')
2010-05-24 03:45:12 +04:00
###############################################################################
2017-08-16 16:00:59 +03:00
$(call def-help-subheading,INSTALLING:)
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
install: \
$(call def-help,install, download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack))
$(STACK) install
2014-08-14 04:48:24 +04:00
###############################################################################
2017-08-16 16:00:59 +03:00
$(call def-help-subheading,BUILDING:)
2014-08-14 04:48:24 +04:00
# EXTRAINSTALLARGS=
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
build: \
$(call def-help,build, download dependencies and build hledger executables (with stack))
$(STACK) build
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
buildtimes: \
$(call def-help,buildtimes, build hledger with GHC 9.2 showing just GHC codegen times/allocations)
time ($(STACK) --stack-yaml=stack9.2.yaml build hledger --force-dirty --ghc-options='-fforce-recomp -ddump-timings' 2>&1 | grep -E '\bCodeGen \[.*time=')
buildtimes-fast: \
$(call def-help,buildtimes-fast, build hledger unoptimised with GHC 9.2 showing just GHC codegen times/allocations)
time ($(STACK) --stack-yaml=stack9.2.yaml build hledger --fast --force-dirty --ghc-options='-fforce-recomp -ddump-timings' 2>&1 | grep -E '\bCodeGen \[.*time=')
buildtimes-cabal: \
$(call def-help,buildtimes-cabal, build hledger with GHC 9.2 showing just GHC codegen times/allocations avoiding double compilation)
cabal clean; time (cabal build -w ghc9.2 ./hledger-lib ./hledger --disable-library-vanilla --enable-executable-dynamic --ghc-options='-fforce-recomp -ddump-timings' 2>&1 | grep -E '\bCodeGen \[.*time=')
buildtimes-cabal-fast: \
$(call def-help,buildtimes-cabal-fast, build hledger unoptimised with GHC 9.2 showing just GHC codegen times/allocations avoiding double compilation)
cabal clean; time (cabal build -w ghc-9.2 -O0 ./hledger-lib ./hledger --disable-library-vanilla --enable-executable-dynamic --ghc-options='-fforce-recomp -ddump-timings' 2>&1 | grep -E '\bCodeGen \[.*time=')
# 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
webdirs: config messages static templates \
$(call def-help,webdirs, sym-link some directories for hledger-web dev\
\
)
config:
echo "Creation of 'config' symlink disabled, it causes makeinfo warnings"
# ln -sf hledger-web/$@
messages:
ln -sf hledger-web/$@
static:
ln -sf hledger-web/$@
templates:
ln -sf hledger-web/$@
2010-11-13 03:07:20 +03:00
save-hledger-unopt: \
$(call def-help,save-hledger-fast, build an unoptimised hledger executable named with git describe in bin )
$(STACK) --verbosity=error install hledger --local-bin-path=bin && mv bin/hledger{,-`git describe --tags`-unopt}
@echo "built bin/hledger-`git describe --tags`-unopt"
save-hledger-unopt-%: \
$(call def-help,save-hledger-fast-EXT, build an unoptimised hledger executable named with the given extension in bin )
$(STACK) --verbosity=error install hledger --local-bin-path=bin && mv bin/hledger{,-$*-unopt}
@echo "built bin/hledger-$*-unopt"
save-hledger: \
$(call def-help,save-hledger, build an optimised hledger executable named with git describe in bin )
$(STACK) --verbosity=error install hledger --local-bin-path=bin && mv bin/hledger{,-`git describe --tags`}
@echo "built bin/hledger-`git describe --tags`"
save-hledger-%: \
$(call def-help,save-hledger-EXT, build an optimised hledger executable named with the given suffix in bin )
$(STACK) --verbosity=error install hledger --local-bin-path=bin && mv bin/hledger{,-$*}
@echo "built bin/hledger-$*"
hledgerprof: \
$(call def-help,hledgerprof, build a hledger executable with profiling enabled (with stack) )
$(STACK) build --profile hledger
# hledger-lib --ghc-options=-fprof-auto
# @echo "to profile, use $(STACK) exec --profile -- hledger ..."
2015-07-13 01:23:42 +03:00
hledgercov: \
$(call def-help,hledgercov, build "bin/hledgercov" for coverage reports (with ghc) )
2019-02-25 03:22:51 +03:00
$(STACK) ghc $(MAIN) -fhpc -o bin/hledgercov -outputdir .hledgercovobjs $(BUILDFLAGS)
2016-04-13 07:10:02 +03:00
# hledger-lib/Hledger/Read/TimeclockReaderPP.hs
dev: dev.hs $(SOURCEFILES) \
$(call def-help,dev, build the dev.hs script for quick experiments (with ghc) )
$(STACK) ghc -- $(CABALMACROSFLAGS) -ihledger-lib dev.hs \
# to get profiling deps installed, first do something like:
# stack build --library-profiling hledger-lib timeit criterion
devprof: dev.hs $(SOURCEFILES) \
$(call def-help,devprof, build the dev.hs script with profiling support )
$(STACK) ghc -- $(CABALMACROSFLAGS) -ihledger-lib dev.hs -rtsopts -prof -fprof-auto -osuf p_o -o devprof
dev-profile: devprof \
$(call def-help,dev-profile, get a time & space profile of the dev.hs script )
time ./devprof +RTS -P \
&& cp devprof.prof devprof.prof.$(TIME) \
&& profiterole devprof.prof
2010-11-29 04:15:08 +03:00
dev-heap: devprof \
2015-10-17 21:23:39 +03:00
$(call def-help,dev-heap, get heap profiles of the dev.hs script )
time ./devprof +RTS -hc -L1000 && cp devprof.hp devprof-hc.hp && hp2ps devprof-hc.hp
time ./devprof +RTS -hr -L1000 && cp devprof.hp devprof-hr.hp && hp2ps devprof-hr.hp
dev-heap-upload:
curl -F "file=@devprof-hc.hp" -F "title='hledger parser'" http://heap.ezyang.com/upload
curl -F "file=@devprof-hr.hp" -F "title='hledger parser'" http://heap.ezyang.com/upload
tools/generatejournal: tools/generatejournal.hs \
$(call def-help,tools/generatejournal, build the generatejournal tool )
2019-02-25 03:22:51 +03:00
$(STACK) ghc tools/generatejournal.hs
ghcid: $(call def-help,ghcid, start ghcid autobuilder on hledger-lib + hledger)
ghcid -c 'make ghci'
ghcid-ui: $(call def-help,ghcid-ui, start ghcid autobuilder on hledger-lib + hledger + hledger-ui)
2022-08-17 13:06:22 +03:00
ghcid -c 'make ghci-ui'
ghcid-web: $(call def-help,ghcid-web, start ghcid autobuilder on hledger-lib + hledger + hledger-web)
ghcid -c 'make ghci-web'
2020-04-07 04:00:25 +03:00
ghcid-web-run: $(call def-help,ghcid-web-run, start ghcid autobuilding and running hledger-web with sample journal on port 5001 )
ghcid -c 'make ghci-web' --test ':main -f examples/sample.journal --port 5001 --serve'
ghcid-test: $(call def-help,ghcid-test, start ghcid autobuilding and running the test command)
ghcid -c 'make ghci' --test ':main test -- --color=always'
ghcid-test-%: $(call def-help,ghcid-test-TESTPATTERN, start ghcid autobuilding and running the test command with this TESTPATTERN)
ghcid -c 'make ghci' --test ':main test -- --color=always -p$*'
ghcid-doctest: $(call def-help,ghcid-doctest, start ghcid autobuilding and running hledger-lib doctests)
ghcid -c 'cd hledger-lib; $(STACK) ghci hledger-lib:test:doctest' --test ':main' --reload hledger-lib
GHCIDRESTART=--restart Makefile --restart Makefile.local
GHCIDRELOAD=--reload t.j --reload t.timedot
GHCIDCMD=:main -f t.j bal date:today -S
ghcid-watch watch: $(call def-help,ghcid-watch, start ghcid autobuilding and running a custom GHCI command with reload/restart on certain files - customise this)
ghcid -c 'make ghci' --test '$(GHCIDCMD)' $(GHCIDRELOAD) $(GHCIDRESTART)
2019-01-30 20:09:04 +03:00
# keep synced with Shake.hs header
SHAKEDEPS= \
--package base-prelude \
--package directory \
--package extra \
--package process \
2020-05-23 17:05:30 +03:00
--package regex \
2019-01-30 20:09:04 +03:00
--package safe \
--package shake \
--package time \
# --package hledger-lib \ # for Hledger.Utils.Debug
2019-01-30 20:09:04 +03:00
ghcid-shake: $(call def-help,ghcid-shake, start ghcid autobuilder on Shake.hs)
stack exec $(SHAKEDEPS) -- ghcid Shake.hs
# multi-package GHCI prompts
ghci: $(call def-help,ghci, start ghci REPL on hledger-lib + hledger)
$(STACKGHCI) exec -- $(GHCI) $(BUILDFLAGS) hledger/Hledger/Cli/Main.hs
2019-06-12 01:09:17 +03:00
ghci-prof: $(call def-help,ghci-prof, start ghci REPL on hledger-lib + hledger with profiling/call stack information)
stack build --profile hledger --only-dependencies
$(STACKGHCI) exec -- $(GHCI) $(BUILDFLAGS) -fexternal-interpreter -prof -fprof-auto hledger/Hledger/Cli/Main.hs
ghci-dev: $(call def-help,ghci-dev, start ghci REPL on hledger-lib + hledger + dev.hs script)
$(STACKGHCI) exec -- $(GHCI) $(BUILDFLAGS) -fno-warn-unused-imports -fno-warn-unused-binds dev.hs
ghci-ui: $(call def-help,ghci-ui, start ghci REPL on hledger-lib + hledger + hledger-ui)
2022-08-17 13:06:22 +03:00
$(STACKGHCI) exec -- $(GHCI) $(BUILDFLAGS) hledger-ui/Hledger/UI/Main.hs
2021-08-04 11:12:19 +03:00
ghci-web: webdirs $(call def-help,ghci-web, start ghci REPL on hledger-lib + hledger + hledger-web)
$(STACKGHCI) exec -- $(GHCI) $(BUILDFLAGS) hledger-web/app/main.hs
2021-08-04 11:12:19 +03:00
ghci-web-test: webdirs $(call def-help,ghci-web-test, start ghci REPL on hledger-lib + hledger + hledger-web + hledger-web test suite)
$(STACKGHCI) exec -- $(GHCI) $(BUILDFLAGS) hledger-web/test/test.hs
2022-06-29 10:03:50 +03:00
# better than stack exec ?
# XXX does not see changes to files
ghci-unit-test: $(call def-help,ghci-unit-test, start ghci REPL on hledger-lib + unit test suite)
$(STACKGHCI) ghci --ghc-options='-rtsopts $(WARNINGS) -ihledger-lib -DDEVELOPMENT -DVERSION="\"1.26.99\""' hledger-lib/test/unittest.hs
2022-06-29 10:03:50 +03:00
# ghci-all: $(call def-help,ghci-all, start ghci REPL on all the hledger)
# $(STACK) exec -- $(GHCI) $(BUILDFLAGS) \
# hledger-ui/Hledger/UI/Main.hs \
# hledger-web/app/main.hs \
ghci-doctest: $(call def-help,ghci-doctest, start ghci REPL on hledger-lib doctests)
cd hledger-lib; $(STACKGHCI) ghci hledger-lib:test:doctest
2019-01-30 20:09:04 +03:00
ghci-shake: $(call def-help,ghci-shake, start ghci REPL on Shake.hs)
2022-01-06 20:08:39 +03:00
$(STACK) exec $(SHAKEDEPS) -- ghci Shake.hs
2019-01-30 20:09:04 +03:00
copy-exe-%: $(call def-help,copy-exe.FOO, copy ~/.local/bin/hledger to hledger-FOO)
cp ~/.local/bin/hledger{,-$*}
copy-exes-%: $(call def-help,copy-exes.FOO, copy ~/.local/bin/hledger* to hledger*-FOO)
for EXE in $(BINARIES); do cp ~/.local/bin/$$EXE{,-$*}; done
install-as-%: $(call def-help,install-as-FOO, like stack install but save executables as bin/old/hledger*-FOO)
@$(STACK) install --local-bin-path bin/old
@printf "\nMoved executables to:\n"
@for EXE in $(BINARIES); do mv bin/old/$$EXE bin/old/$$EXE-$*; echo "- bin/$$EXE-$*"; done
# make must be GNU Make 4.3+
.PHONY: shellcompletions
shellcompletions: $(call def-help,shellcompletions, update shell completions in hledger package)
make -C hledger/shell-completion/ clean-all all
###############################################################################
2017-08-16 16:00:59 +03:00
$(call def-help-subheading,TESTING:)
test: functest bench \
$(call def-help,test, run default tests: functional tests (including unit tests) and benchmarks )
2009-06-28 07:17:02 +04:00
# For quieter tests add --silent. It may hide troubleshooting info.
# For very verbose tests add --verbosity=debug. It seems hard to get something in between.
STACKTEST=$(STACK) test --fast
# When doing build testing, save a little time and output noise by not
# running tests & benchmarks. Comment this out if you want to run them.
SKIPTESTSBENCHS=--no-run-tests --no-run-benchmarks
2017-04-01 03:57:12 +03:00
2018-10-24 19:47:48 +03:00
buildplantest: $(call def-help,buildplantest, stack build --dry-run all hledger packages ensuring an install plan with default snapshot) \
buildplantest-stack.yaml
buildplantest-all: $(call def-help,buildplantest-all, stack build --dry-run all hledger packages ensuring an install plan with each ghc version/stackage snapshot )
2020-06-07 01:18:01 +03:00
for F in stack*.yaml; do make --no-print-directory buildplantest-$$F; done
2018-10-24 19:47:48 +03:00
2020-03-31 01:35:53 +03:00
buildplantest-%: $(call def-help,buildplantest-STACKFILE, stack build --dry-run all hledger packages ensuring an install plan with the given stack yaml file; eg make buildplantest-stack8.2.yaml )
2018-10-24 19:47:48 +03:00
$(STACK) build --dry-run --test --bench --stack-yaml=$*
buildtest: $(call def-help,buildtest, force-rebuild all hledger packages/modules quickly ensuring no warnings with default snapshot) \
buildtest-stack.yaml
buildtest-all: $(call def-help,buildtest-all, force-rebuild all hledger packages/modules quickly ensuring no warnings with each ghc version/stackage snapshot )
2020-06-07 01:18:01 +03:00
for F in stack*.yaml; do make --no-print-directory buildtest-$$F; done
2020-03-31 01:35:53 +03:00
buildtest-%: $(call def-help,buildtest-STACKFILE, force-rebuild all hledger packages/modules quickly ensuring no warnings with the given stack yaml file; eg make buildtest-stack8.2.yaml )
$(STACK) build --test --bench $(SKIPTESTSBENCHS) --fast --force-dirty --ghc-options=-fforce-recomp --ghc-options=-Werror --stack-yaml=$*
incr-buildtest: $(call def-help,incr-buildtest, build any outdated hledger packages/modules quickly ensuring no warnings with default snapshot. Wont detect warnings in up-to-date modules.) \
incr-buildtest-stack.yaml
incr-buildtest-all: $(call def-help,incr-buildtest-all, build any outdated hledger packages/modules quickly ensuring no warnings with each ghc version/stackage snapshot. Wont detect warnings in up-to-date modules. )
2020-06-07 01:18:01 +03:00
for F in stack*.yaml; do make --no-print-directory incr-buildtest-$$F; done
2020-03-31 01:35:53 +03:00
incr-buildtest-%: $(call def-help,incr-buildtest-STACKFILE, build any outdated hledger packages/modules quickly ensuring no warnings with the stack yaml file; eg make buildtest-stack8.2.yaml. Wont detect warnings in up-to-date modules. )
$(STACK) build --test --bench $(SKIPTESTSBENCHS) --fast --ghc-options=-Werror --stack-yaml=$*
2020-06-07 01:23:07 +03:00
stack-clean-all: $(call def-help,stack-clean-all, do a stack clean --full with all ghc versions for paranoia/troubleshooting )
for F in stack*.yaml; do $(STACK) clean --full --stack-yaml=$$F; done
2020-06-07 21:51:24 +03:00
ghcversions: $(call def-help,ghcversions, show the ghc versions used by all stack files )
for F in stack*.yaml; do $(STACK) --stack-yaml=$$F --no-install-ghc exec -- ghc --version; done 2>&1 | grep -v 'To install the correct GHC'
pkgtest: $(call def-help,pkgtest, run the test suites in each package )
@($(STACKTEST) && echo $@ PASSED) || (echo $@ FAILED; false)
2009-06-28 07:17:02 +04:00
# doctest with ghc 8.4 on mac requires a workaround, see hledger-lib/package.yaml.
# Or, could run it with ghc 8.2:
2020-03-31 01:35:53 +03:00
# @($(STACKTEST) --stack-yaml stack8.2.yaml hledger-lib:test:doctest && echo $@ PASSED) || (echo $@ FAILED; false)
doctest: $(call def-help,doctest, run the doctests in hledger-lib module/function docs )
@($(STACKTEST) hledger-lib:test:doctest && echo $@ PASSED) || (echo $@ FAILED; false)
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
unittest: $(call def-help,unittest, run the unit tests in hledger-lib )
2020-12-29 21:32:17 +03:00
@($(STACKTEST) hledger-lib:test:unittest && echo $@ PASSED) || (echo $@ FAILED; false)
# assumes an up to date hledger executable is built.
# I think we don't do it automatically to minimise unnecessary rebuilding.
builtintest: $(call def-help,builtintest, run hledgers built in test command)
@($(STACK) exec hledger test && echo $@ PASSED) || (echo $@ FAILED; false)
# hledger executable to functional test: by default the development build
# in this directory, can be overridden by env var.
# eg: FUNCTESTEXE=hledger-1.20 make functest
FUNCTESTEXE ?= `$(STACK) exec -- which hledger`
#functest: addons hledger/test/addons/hledger-addon
functest: hledger/test/addons/hledger-addon \
$(call def-help,functest, build hledger quickly and quietly run the functional tests (and some unit tests) )
@$(STACK) build --fast hledger
@($(SHELLTESTSTK) --hide-successes -w $(FUNCTESTEXE) \
hledger/test/ bin/ \
-x ledger-compat/baseline -x ledger-compat/regress -x ledger-compat/collected \
&& echo $@ PASSED) || (echo $@ FAILED; false)
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
functest-%: hledger/test/addons/hledger-addon \
2019-06-12 01:09:17 +03:00
$(call def-help,functest-PAT, build hledger quickly and run just the functional tests matching PAT )
@$(STACK) build --fast hledger
@($(SHELLTESTSTK) -w $(FUNCTESTEXE) hledger/test/ -i "$*" \
2019-06-12 01:09:17 +03:00
&& echo $@ PASSED) || (echo $@ FAILED; false)
ADDONEXTS=pl py rb sh hs lhs rkt exe com bat
hledger/test/addons/hledger-addon: \
$(call def-help,hledger/test/addons/hledger-addon,\
generate dummy add-ons for testing (hledger-addon the rest)\
)
rm -rf hledger/test/addons/hledger-*
printf '#!/bin/sh\necho add-on: $$0\necho args: $$*\n' >hledger/test/addons/hledger-addon
for E in '' $(ADDONEXTS); do \
cp hledger/test/addons/hledger-addon hledger/test/addons/hledger-addon.$$E; done
for F in addon. addon2 addon2.hs addon3.exe addon3.lhs addon4.exe add reg; do \
cp hledger/test/addons/hledger-addon hledger/test/addons/hledger-$$F; done
mkdir hledger/test/addons/hledger-addondir
chmod +x hledger/test/addons/hledger-*
# hlinttest hlint: $(call def-help,hlinttest (or hlint),generate a hlint report)
# hlint --hint=hlint --report=hlint.html $(SOURCEFILES)
2015-07-13 01:23:42 +03:00
haddocktest: $(call def-help,haddocktest, run haddock to make sure it can generate docs without dying )
@(make --quiet haddock && echo $@ PASSED) || (echo $@ FAILED; false)
2010-12-11 01:09:32 +03:00
cabalfiletest: $(call def-help,cabalfiletest, run cabal check to test cabal file syntax )
@(make --no-print-directory cabalcheck && echo $@ PASSED) || (echo $@ FAILED; false)
2010-05-23 01:24:07 +04:00
test-stack%yaml:
$(STACK) --stack-yaml stack$*yaml clean
$(STACK) --stack-yaml stack$*yaml build --ghc-options="$(WARNINGS) -Werror" --test --bench --haddock --no-haddock-deps
travistest: $(call def-help,travistest, run tests similar to our travis CI tests)
2018-06-04 03:12:32 +03:00
$(STACK) clean
$(STACK) build --ghc-options=-Werror --test --haddock --no-haddock-deps hledger-lib
$(STACK) build --ghc-options=-Werror --test --haddock --no-haddock-deps hledger
$(STACK) build --ghc-options=-Werror --test --haddock --no-haddock-deps hledger-ui
$(STACK) build --ghc-options=-Werror --test --haddock --no-haddock-deps hledger-web
make functest
# committest: hlinttest unittest doctest functest haddocktest buildtest quickcabaltest \
# $(call def-help,committest,more thorough pre-commit/pre-push tests)
# releasetest: Clean unittest functest fullcabaltest haddocktest #buildtest doctest \
# $(call def-help,releasetest,pre-release tests)
HLEDGERINSTALLSH=$(PWD)/hledger-install/hledger-install.sh
installtest: $(call def-help,installtest, run hledger-install.sh from another directory)
(cd; $(HLEDGERINSTALLSH))
###############################################################################
$(call def-help-subheading,BENCHMARKING:)
samplejournals: $(call def-help,samplejournals, regenerate standard sample journals in examples/) \
examples/sample.journal \
examples/10x10x10.journal \
examples/100x100x10.journal \
examples/1000x1000x10.journal \
examples/1000x10000x10.journal \
examples/2000x1000x10.journal \
examples/3000x1000x10.journal \
examples/4000x1000x10.journal \
examples/5000x1000x10.journal \
examples/6000x1000x10.journal \
examples/7000x1000x10.journal \
examples/8000x1000x10.journal \
examples/9000x1000x10.journal \
examples/10000x1000x10.journal \
examples/10000x10000x10.journal \
examples/100000x1000x10.journal \
examples/1000000x1000x10.journal \
# examples/ascii.journal \
# examples/chinese.journal \
# examples/mixed.journal \
examples/sample.journal:
true # XXX should probably regenerate this
examples/10x10x10.journal: tools/generatejournal
tools/generatejournal 10 10 10 >$@
examples/100x100x10.journal: tools/generatejournal
tools/generatejournal 100 100 10 >$@
examples/1000x1000x10.journal: tools/generatejournal
tools/generatejournal 1000 1000 10 >$@
examples/1000x10000x10.journal: tools/generatejournal
tools/generatejournal 1000 10000 10 >$@
examples/2000x1000x10.journal: tools/generatejournal
tools/generatejournal 2000 1000 10 >$@
examples/3000x1000x10.journal: tools/generatejournal
tools/generatejournal 3000 1000 10 >$@
examples/4000x1000x10.journal: tools/generatejournal
tools/generatejournal 4000 1000 10 >$@
examples/5000x1000x10.journal: tools/generatejournal
tools/generatejournal 5000 1000 10 >$@
examples/6000x1000x10.journal: tools/generatejournal
tools/generatejournal 6000 1000 10 >$@
examples/7000x1000x10.journal: tools/generatejournal
tools/generatejournal 7000 1000 10 >$@
examples/8000x1000x10.journal: tools/generatejournal
tools/generatejournal 8000 1000 10 >$@
examples/9000x1000x10.journal: tools/generatejournal
tools/generatejournal 9000 1000 10 >$@
examples/10000x1000x10.journal: tools/generatejournal
tools/generatejournal 10000 1000 10 >$@
examples/10000x10000x10.journal: tools/generatejournal
tools/generatejournal 10000 10000 10 >$@
examples/100000x1000x10.journal: tools/generatejournal
tools/generatejournal 100000 1000 10 >$@
examples/1000000x1000x10.journal: tools/generatejournal
tools/generatejournal 1000000 1000 10 >$@
examples/ascii.journal: tools/generatejournal
tools/generatejournal 3 5 5 >$@
examples/chinese.journal: tools/generatejournal
tools/generatejournal 3 5 5 --chinese >$@
examples/mixed.journal: tools/generatejournal
tools/generatejournal 3 5 5 --mixed >$@
# hledger executables to bench test, can be overridden by env var,
# eg: BENCHEXES=ledger,hledger-1.18,hledger make bench
BENCHEXES ?= hledger
2016-10-21 05:05:07 +03:00
bench: quickbench
2020-09-10 03:44:14 +03:00
quickbench: samplejournals bench.sh $(call def-help,quickbench, benchmark commands in bench.sh with quickbench and $(BENCHEXES))
@echo; echo "run quick performance benchmarks in bench.sh (approximate, can be skewed):"
2021-06-16 21:25:52 +03:00
@which quickbench >/dev/null && quickbench -w $(BENCHEXES) || echo "quickbench not installed (see bench.sh), skipping"
2008-12-10 23:46:18 +03:00
# 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
throughput: throughput-hledger \
$(call def-help,throughput, show throughput at various data sizes with the default hledger executable )
throughput-%: samplejournals \
$(call def-help,throughput-HLEDGEREXE, show throughput at various data sizes with the given hledger executable )
@echo date: `date`
@echo system: `uname -a`
@echo executable: $*
@echo version: `$* --version`
2021-11-21 11:55:16 +03:00
@for n in 1000 2000 3000 4000 5000 6000 7000 8000 9000 10000 100000 ; do \
2021-12-10 01:24:19 +03:00
printf "%6d txns: " $$n; $* stats -f examples/$${n}x1000x10.journal | tail -1; \
2021-11-21 11:55:16 +03:00
done
@date
2021-11-26 20:20:39 +03:00
throughput-dev: samplejournals \
$(call def-help,throughput-dev, show throughput at various data sizes with the latest hledger dev build (optimised or not) )
@stack build hledger
@stack exec -- make -s throughput
# prof: samplejournals \
# $(call def-help,prof,\
# generate and archive an execution profile\
# ) #bin/hledgerprof
# @echo "Profiling: $(PROFCMD)"
# -$(PROFCMD) +RTS $(PROFRTSFLAGS) -RTS
# mv hledgerprof.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-%: hledgerprof samplejournals \
2019-08-01 19:30:46 +03:00
$(call def-help,quickprof-"CMD", run some command against a standard sample journal and display the execution profile )
$(STACK) exec --profile -- hledger +RTS $(PROFRTSFLAGS) -RTS $* -f examples/1000x1000x10.journal >/dev/null
profiterole hledger.prof
@echo
@head -20 hledger.prof
@echo ...
@echo
@head -20 hledger.profiterole.txt
@echo ...
@echo
@echo "See hledger.prof, hledger.profiterole.txt, hledger.profiterole.html for more."
# heap: samplejournals \
# $(call def-help,heap,\
# generate and archive a graphical heap profile\
# ) #bin/hledgerprof
# @echo "Profiling heap with: $(PROFCMD)"
# $(PROFCMD) +RTS -hc -RTS
# mv hledgerprof.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-%: hledgerprof samplejournals \
$(call def-help,quickheap-"CMD", run some command against a sample journal and display the heap profile )
2017-01-08 16:20:04 +03:00
$(STACK) exec -- hledgerprof +RTS -hc -RTS $* -f examples/10000x1000x10.journal >/dev/null
hp2ps hledgerprof.hp
@echo generated hledgerprof.ps
$(VIEWPS) hledgerprof.ps
# quickcoverage: hledgercov \
# $(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/runhledgercov "report" $(COVCMD)
# coverage: samplejournals hledgercov \
# $(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/runhledgercov "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
###############################################################################
2019-02-04 02:56:57 +03:00
$(call def-help-subheading,DOCUMENTATION: (see also Shake.hs))
# 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' \
2023-03-15 23:45:39 +03:00
releasediag: \
$(call def-help,releasediag, optimise and commit RELEASING value map diagram )
pngquant doc/HledgerReleaseValueMap.png -f -o doc/HledgerReleaseValueMap.png && git add doc/HledgerReleaseValueMap.png && git commit -m ';doc: RELEASING: update value map' -- doc/HledgerReleaseValueMap.png
haddock: \
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
$(call def-help,haddock, generate haddock docs for the hledger packages )
2020-12-10 01:08:46 +03:00
$(STACK) haddock --no-haddock-deps --fast --no-keep-going
# $(STACK) -v
2020-12-10 01:08:46 +03:00
haddock-watch: \
$(call def-help,haddock-watch, regenerate haddock docs )
$(STACK) haddock --no-haddock-deps --fast --file-watch
haddock-open: \
$(call def-help,haddock-open,\
browse the haddock generated for hledger-lib\
)
$(VIEWHTML) hledger/dist/doc/html/hledger-lib/index.html
hoogle-setup: $(call def-help,hoogle-setup, install hoogle then build haddocks and a hoogle db for the project and all deps )
stack hoogle --rebuild
HOOGLEBROWSER="/Applications/Firefox Dev.app/Contents/MacOS/firefox" # safari not supported
2022-11-08 05:37:00 +03:00
hoogle-serve: $(call def-help,hoogle-serve, run hoogle web app and open in browser after doing setup if needed )
$(HOOGLEBROWSER) http://localhost:8080 &
stack --verbosity=warn hoogle --server
# sourcegraph: \
# $(call def-help,sourcegraph,\
# \
# )
# for p in $(PACKAGES); do (cd $$p; SourceGraph $$p.cabal); done
manuals-watch: Shake \
2020-02-03 21:38:39 +03:00
$(call def-help,manuals-watch, rerender manuals when their source files change )
ls $(DOCSOURCEFILES) | entr ./Shake -VV manuals
2022-12-14 18:55:44 +03:00
man-watch: man-watch-hledger \
$(call def-help,man-watch, run man on the hledger man page when its source file changes )
2022-11-03 20:10:54 +03:00
man-watch-%: Shake \
$(call def-help,man-watch-PROG, run man on the given man page when its source file changes. Eg make man-watch-hledger-web )
$(WATCHEXEC) -r -w $*/$*.m4.md './Shake $*/$*.1 && man $*/$*.1'
shakehelp-watch: \
$(call def-help,shakehelp-watch, rerender Shake.hs's help when it changes)
ls Shake.hs | entr -c ./Shake.hs
2022-12-01 22:21:19 +03:00
# The following rule, for updating the website, gets called on hledger.org by:
# 1. github-post-receive (github webhook handler), when something is pushed
# to the main or wiki repos on Github. Config:
# /etc/supervisord.conf -> [program:github-post-receive]
# /etc/github-post-receive.conf
# 2. cron, nightly. Config: /etc/crontab
# 3. manually: "make site" on hledger.org, or "make hledgerorg" elsewhere (cf Makefile.local).
2022-12-01 22:21:19 +03:00
.PHONY: site
2022-12-01 22:21:19 +03:00
# Use the existing Shake executable without recompiling it, so as not to automatially run unreviewed code by hook ? I think this no longer applies.
# site: $(call def-help,site-build, update the hledger.org website (run this on hledger.org, or run "make hledgerorg" elsewhere) )
# @[ ! -x Shake ] \
# && echo 'Please run "make Shake" first (manual compilation required for safety)' \
# || ( \
# echo; \
# ./Shake -V site; \
# ) 2>&1 | tee -a site.log
site: Shake \
$(call def-help,site, update the hledger.org website (run on hledger.org, or run "make hledgerorg" elsewhere) )
./Shake -V site 2>&1 | tee -a site.log
2018-11-25 04:43:26 +03:00
2021-08-24 23:46:57 +03:00
BROWSE=open
BROWSEDELAY=5
LOCALSITEURL=http://localhost:3000/dev/hledger.html
site-watch: $(call def-help,site-watch, open a browser on the website (in ./site) and rerender when docs or web pages change )
@make -s Shake
@(printf "\nbrowser will open in $(BROWSEDELAY)s (adjust BROWSE in Makefile if needed)...\n\n"; sleep $(BROWSEDELAY); $(BROWSE) $(LOCALSITEURL)) &
@$(WATCHEXEC) --print-events -e md,m4 -i hledger.md -i hledger-ui.md -i hledger-web.md -r './Shake webmanuals && ./Shake orgfiles && make -sC site serve'
2021-08-24 23:46:57 +03:00
###############################################################################
2017-08-16 16:00:59 +03:00
$(call def-help-subheading,RELEASING:)
# old/desired release process:
# a normal release: echo 0.7 >.version; make release
# a bugfix release: echo 0.7.1 >.version; make release
#release: releasetest bumpversion tagrelease $(call def-help,release, prepare and test a release and tag the repo )
#publish: hackageupload pushtags $(call def-help,upload, publish latest hackage packages and push tags to github )
#releaseandpublish: release upload $(call def-help,releaseandpublish, release and upload and publish updated docs )
ISCLEAN=git diff-index --quiet HEAD --
# stop if the working directory has uncommitted changes
iscleanwd:
@$(ISCLEAN) || (echo "please clean the working directory first"; false)
# stop if the given file(s) have uncommitted changes
isclean-%:
@$(ISCLEAN) $* || (echo "please clean these files first: $*"; false)
2009-12-12 05:55:59 +03:00
# update all cabal files based on latest package.yaml files using stack's built-in hpack
cabal: $(call def-help,cabal, regenerate cabal files from package.yaml files with stack )
$(STACK) build --dry-run --silent
# Update all cabal files based on latest package.yaml files using a specific hpack version.
# To avoid warnings, this should be the same version as stack's built-in hpack.
cabal-with-hpack-%:
2019-03-06 22:13:04 +03:00
$(STACK) build --with-hpack hpack-$* --dry-run --silent
2018-04-20 06:49:08 +03:00
2018-01-04 21:25:10 +03:00
# updatecabal: gencabal $(call def-help,updatecabal, regenerate cabal files and commit )
# @read -p "please review changes then press enter to commit $(shell ls */*.cabal)"
# git commit -m "update cabal files" $(shell ls */*.cabal)
# we use shake for this job; so dependencies aren't checked here
manuals: Shake $(call def-help,manuals, regenerate and commit CLI help and manuals (might need -B) )
./Shake manuals
2020-01-23 01:43:47 +03:00
git commit -m ";doc: regen manuals" -m "[ci skip]" hledger*/hledger*.{1,5,info,txt} hledger/Hledger/Cli/Commands/*.txt
2021-03-10 22:55:20 +03:00
tag: $(call def-help,tag, make git release tags for the project and all packages )
@for p in $(PACKAGES); do make tag-$$p; done
@make tag-project
tag-%: $(call def-help,tag-PKG, make a git release tag for PKG )
git tag -fs $*-`cat $*/.version` -m "Release $*-`cat $*/.version`"
tag-project: $(call def-help,tag-project, make a git release tag for the project as a whole )
git tag -fs `cat .version` -m "Release `cat .version`, https://hledger.org/release-notes.html#hledger-`cat .version | sed -e 's/\./-/g'`"
@printf "if tagging a major release, please also review and run this command:\n"
@printf " git tag -fs `cat .version`.99 master -m \"Start of next release cycle. This tag influences git describe and dev builds' version strings.\"\n"
# hackageupload-dry: \
# $(call def-help,hackageupload-dry,\
# upload all packages to hackage; dry run\
# )
# for p in $(PACKAGES); do cabal upload $$p/dist/$$p-$(VERSION).tar.gz -v2 --check; done
2017-04-01 04:16:04 +03:00
hackageupload: \
$(call def-help,hackageupload, upload all packages to hackage from a release branch)
tools/hackageupload $(PACKAGES)
# showreleasestats stats: \
# showreleasedays \
# showunreleasedchangecount \
# showloc \
# showtestcount \
# showunittestcoverage \
# showreleaseauthors \
# showunreleasedcodechanges \
# showunpushedchanges \
# $(call def-help,showreleasestats stats,\
# show project stats useful for release notes\
# )
# # showerrors
2012-10-22 01:09:24 +04:00
# FROMTAG=.
# showreleasedays: \
# $(call def-help,showreleasedays,\
# \
# )
# @echo Days since last release:
# @tools/dayssincetag.hs $(FROMTAG) | head -1 | cut -d' ' -f-1
# @echo
# # XXX
# showunreleasedchangecount: \
# $(call def-help,showunreleasedchangecount,\
# \
# )
# @echo Commits since last release:
# @darcs changes --from-tag $(FROMTAG) --count
# @echo
describe: $(call def-help,describe, show a precise git-describe version string )
@git describe --tags --match 'hledger-[0-9]*' --dirty
# showreleaseauthors: $(call def-help,showreleaseauthors, show author names since last release)
# @echo Commit authors since last release:
# @git shortlog -sn $(CHANGELOGSTART).. # TODO undefined
2021-08-20 22:21:46 +03:00
showauthors: $(call def-help,showauthors, show all commit author names)
@echo "Commit authors ($$(git shortlog -sn | wc -l | awk '{print $$1}'))":
@git shortlog -sn
cloc: $(call def-help,cloc, count lines of source code )
2016-01-17 19:52:19 +03:00
@echo Lines of code including tests:
@cloc --exclude-lang=HTML --exclude-dir=.stack-work,.idea,dist,old,bin,doc,site,.tutorial-data,static,angular .
2022-07-11 13:35:55 +03:00
SCC=scc -z --cocomo-project-type semi-detached -f wide -s code
scc: $(call def-help,scc, count lines of source code with scc)
@echo Lines of code including tests:
@$(SCC) -i hs,sh,m4,hamlet
sccv: $(call def-help,sccv, count lines of source code with scc showing all files)
@echo Lines of code including tests:
@$(SCC) -i hs,sh,m4,hamlet --by-file
2016-01-17 19:52:19 +03:00
# `ls $(SOURCEFILES)`
# sloc: \
# $(call def-help,sloc,\
# \
# )
# @sloccount hledger-lib hledger hledger-web
# cloc: \
# $(call def-help,cloc,\
# \
# )
# @echo
# @echo "Lines of code as of `date`:"
# @echo
# @echo "hledger-lib, hledger"
# @cloc -q hledger-lib hledger 2>&1 | grep -v 'defined('
# @echo
# @echo "hledger-web"
# @cloc -q hledger-web 2>&1 | grep -v 'defined('
# @echo
# @echo "hledger-lib, hledger, hledger-web"
# @cloc -q hledger-lib hledger hledger-web 2>&1 | grep -v 'defined('
# showtestcount: \
# $(call def-help,showtestcount,\
# \
# )
# @echo "Unit tests:"
# @hledger test 2>&1 | cut -d' ' -f2
# @echo "Functional tests:"
# @make --no-print functest | egrep '^ Total' | awk '{print $$2}'
# @echo
2013-07-11 02:29:00 +04:00
# showunittestcoverage: \
# $(call def-help,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
# # XXX
# showunpushedchanges showunpushed: \
# $(call def-help,showunpushedchanges showunpushed,\
# \
# )
# @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
# # XXX
# showunreleasedcodechanges showunreleased showchanges: \
# $(call def-help,showunreleasedcodechanges showunreleased showchanges,\
# \
# )
# @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
# # XXX
# showcodechanges: \
# $(call def-help,showcodechanges,\
# \
# )
# @echo "hledger code changes:"
# @darcs changes --matches "not (name docs: or name site: or name tools:)" | egrep '^ +(\*|tagged)'
# @echo
2020-06-22 18:00:48 +03:00
nix-hledger-version: $(call def-help,nix-hledger-version, show which version of hledger has reached nixpkgs)
@curl -s https://raw.githubusercontent.com/NixOS/nixpkgs/master/pkgs/development/haskell-modules/hackage-packages.nix | grep -A1 'pname = "hledger"'
nix-hledger-versions: $(call def-help,nix-hledger-versions, show versions of all hledger packages in nixpkgs)
@curl -s https://raw.githubusercontent.com/NixOS/nixpkgs/master/pkgs/development/haskell-modules/hackage-packages.nix | grep -A1 'pname = "hledger'
2021-08-20 22:21:46 +03:00
nix-view-commits: $(call def-help,nix-view-commits, show recent haskell commits in nixpkgs)
2021-07-08 02:19:29 +03:00
@open 'https://github.com/NixOS/nixpkgs/commits/master/pkgs/development/haskell-modules/hackage-packages.nix'
2020-09-10 21:56:55 +03:00
2021-08-20 22:21:46 +03:00
list-commits: $(call def-help,list-commits, list all commits chronologically and numbered)
@git log --format='%ad %h %s (%an)' --date=short --reverse | cat -n
###############################################################################
2017-08-16 16:00:59 +03:00
$(call def-help-subheading,MISCELLANEOUS:)
installcommithook: $(call def-help,installcommithook, symlink tools/commitlint as .git/hooks/commit-msg)
ln -s ../../tools/commitlint .git/hooks/commit-msg
2021-07-28 22:57:06 +03:00
watch-%: $(call def-help,watch-RULE, run make RULE repeatedly when any committed file changes)
2018-05-18 05:10:12 +03:00
@git ls-files | entr -r make $*
Shake: Shake.hs $(call def-help,Shake, ensure the Shake script is compiled )
./Shake.hs
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
usage: cabalusage stackusage \
$(call def-help,usage, show size of various dirs )
du -sh .git bin data doc extra
du -sh .
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
stackusage: \
$(call def-help,stackusage, show size of stack working dirs if any )
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
-du -shc `find . -name '.stack*'`
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
cabalusage: \
$(call def-help,cabalusage, show size of cabal working dirs if any )
-du -shc */dist* 2>/dev/null
2014-10-18 21:18:36 +04:00
2023-04-27 22:17:03 +03:00
# Generate an emacs TAGS file. Tag:
# 1. haskell source files with hasktags
# 2. other source files recognised by (exuberant) ctags and not excluded by .ctags. Keep .ctags up to date.
# 3. some extra files missed by the above, as just their file names (for tags-search, tags-query-replace etc.)
etags:$(call def-help,etags, generate emacs TAGS file for haskell source and other project files )
hasktags -e $(SOURCEFILES)
2023-04-27 22:17:03 +03:00
ctags -a -e -R
for f in \
$(WEBTEMPLATEFILES) \
$(DOCSOURCEFILES) \
$(HPACKFILES) \
$(CABALFILES) \
2019-01-27 03:22:47 +03:00
Shake.hs \
; do printf " \n$$f,1\n" >> TAGS; done
2023-04-27 22:17:03 +03:00
-etagsls >TAGS.files
2023-05-18 19:17:50 +03:00
etags-ls: # list files indexed in TAGS
@rg -v '[  ]' TAGS | rg -r '$$1' '^(.*?)([0-9]+)?,[0-9,]+*'
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
cleantags: \
$(call def-help-hide,cleantags, remove tag files )
rm -f TAGS tags
2014-10-18 21:18:36 +04:00
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
stackclean: \
2020-04-20 23:12:41 +03:00
$(call def-help-hide,stackclean, remove .stack-work/ dirs )
$(STACK) purge
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
cleanghco: \
$(call def-help-hide,cleanghc, remove ghc build leftovers )
rm -rf `find . -name "*.o" -o -name "*.hi" -o -name "*.dyn_o" -o -name "*.dyn_hi" -o -name "*~" | grep -vE '\.(stack-work|cabal-sandbox|virthualenv)'`
2020-04-20 23:12:41 +03:00
#rm -f `fd -I '\.(hi|o|dyn_hi|dyn_o)$'`
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
clean: cleanghco \
$(call def-help,clean, default cleanup (ghc build leftovers) )
2019-09-11 03:25:53 +03:00
Clean: stackclean cleanghco cleantags \
$(call def-help,Clean, thorough cleanup (stack/ghc leftovers/tags) )
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
# reverse = $(if $(wordlist 2,2,$(1)),$(call reverse,$(wordlist 2,$(words $(1)),$(1))) $(firstword $(1)),$(1))
###############################################################################
# END
2014-10-18 20:30:53 +04:00
# optional local customisations, not in version control
-include Makefile.local
tools: new makefile updates The makefile now uses stack primarily. The following updated rules are available: $ make Makefile:35: -------------------- hledger make rules -------------------- Makefile:37: make [help] -- list documented rules in this makefile. make -n RULE shows more detail. Makefile:202: (INSTALLING:) Makefile:204: make install -- download dependencies and install hledger executables to ~/.local/bin or equivalent (with stack) Makefile:229: (BUILDING:) Makefile:233: make build -- download dependencies and build hledger executables (with stack) Makefile:302: make hledgerdev -- quickly build the hledger executable (with ghc and -DDEVELOPMENT) Makefile:487: (TESTING:) Makefile:495: make test -- run default tests Makefile:541: make pkgtest -- run the test suites for each package Makefile:548: make builtintest -- run tests built in to the hledger executable (subset of pkg tests) Makefile:572: make functest -- run hledger functional tests with the stack build Makefile:606: make haddocktest -- run haddock and make sure it succeeds Makefile:787: (DOCUMENTATION:) Makefile:895: make haddock -- generate haddock docs for the hledger packages Makefile:974: (RELEASING:) Makefile:1053: make setversion -- update all version strings to match .version Makefile:1056: make setversionforce -- update all version strings even if .version seems unchanged Makefile:1080: make tagrelease -- commit a release tag based on .version for each package Makefile:1253: (MISCELLANEOUS:) Makefile:1255: make usage -- show size of various dirs Makefile:1260: make stackusage -- show size of stack working dirs Makefile:1264: make cabalusage -- show size of cabal working dirs if any Makefile:1268: make tag -- generate tag files for source code navigation (for emacs) Makefile:1294: make clean -- default cleanup (ghc build leftovers) Makefile:1297: make Clean -- thorough cleanup (stack/cabal/ghc builds and tags) Makefile:1302: make cabalCMD -- run cabal CMD inside each hledger package directory Makefile:1306: make all"CMD" -- run CMD inside each hledger package directory
2015-07-12 22:03:43 +03:00
# show a final message in make help
$(call def-help-heading,)
2020-09-05 03:08:32 +03:00
$(call def-help-heading,See also ./Shake.hs help)