makefile

##
# Stan
# -----------------
#
# To customize your build, set make variables in either:
#    ~/.config/stan/make.local
#    make/local
# Variables in make/local is loaded after ~/.config/stan/make.local


## 'help' is the default make target.
help:

-include $(HOME)/.config/stan/make.local  # user-defined variables
-include make/local                       # user-defined variables

MATH ?= lib/stan_math/

-include $(MATH)make/compiler_flags
-include $(MATH)make/dependencies
-include $(MATH)make/libraries
include make/doxygen                      # doxygen
include make/cpplint                      # cpplint
include make/tests                        # tests
include make/clang-tidy

INC_FIRST = -I $(if $(STAN),$(STAN)/src,src) -I ./src/

.PHONY: help
help:
	@echo '--------------------------------------------------------------------------------'
	@echo 'Note: testing of Stan is typically done with the `runTests.py` python script.'
	@echo '  See https://github.com/stan-dev/stan/wiki/Testing-Stan-using-Gnu-Make-and-Python'
	@echo '  for more detail on testing.'
	@echo ''
	@echo 'Stan makefile:'
	@$(MAKE) print-compiler-flags
	@echo ''
	@echo 'Common targets:'
	@echo '  Documentation:'
	@echo '  - doxygen        : Builds the API documentation. The documentation is located'
	@echo '                     doc/api/'
	@echo '                     (requires doxygen installation)'
	@echo '  Submodule:'
	@echo '  - math-revert    : Reverts the Stan Math Library git submodule to the hash'
	@echo '                     recorded in the Stan library'
	@echo '  - math-update    : Updates the Stan Math Library git submodule branch,'
	@echo '                     e.g. if the Math branch is `develop`, it will fetch the'
	@echo '                     the latest version of `develop`'
	@echo '  - math-update/<branch-name> : Updates the Stan Math Library git submodule to'
	@echo '                     the branch specified'
	@echo ''
	@echo 'Tests:'
	@echo ''
	@echo '  Unit tests are built through make by specifying the executable as the target'
	@echo '  to make. For a test in src/test/*_test.cpp, the executable is test/*$(EXE).'
	@echo ''
	@echo '  Header tests'
	@echo '  - test-headers  : tests all source headers to ensure they are compilable and'
	@echo '                     include enough header files.'
	@echo ''
	@echo '  To run a single header test, add "-test" to the end of the file name.'
	@echo '  Example: make src/stan/math/constants.hpp-test'
	@echo ''
	@echo '  Cpplint'
	@echo '  - cpplint       : runs cpplint.py on source files. requires python 2.7.'
	@echo '                    cpplint is called using the CPPLINT variable:'
	@echo '                      CPPLINT = $(CPPLINT)'
	@echo '                    To set the version of python 2, set the PYTHON2 variable:'
	@echo '                      PYTHON2 = $(PYTHON2)'
	@echo ''
	@echo ' Clang Tidy'
	@echo ' - clang-tidy     : runs the clang-tidy makefile over the test suite.'
	@echo '                    Options:'
	@echo '                     files: (Optional) regex for file names to include in the check'
	@echo '                      Default runs all the tests in unit'
	@echo '                     tidy_checks: (Optional) A set of checks'
	@echo '                      Default runs a hand picked selection of tests'
	@echo ''
	@echo '     Example: This runs clang-tidy over all the multiply tests in prim'
	@echo ''
	@echo '     make clang-tidy files=*prim*multiply*'
	@echo ''
	@echo ' - clang-tidy-fix : same as above but runs with the -fix flag.'
	@echo '                    For automated fixes, outputs a yaml named'
	@echo '                    .clang-fixes.yml'
	@echo ''
	@echo ' Clang Format'
	@echo ' - clang-format     : runs clang-format over all the .hpp and .cpp files.'
	@echo '                      in src.'
	@echo ''
	@echo 'Clean:'
	@echo '  - clean         : Basic clean. Leaves doc and compiled libraries intact.'
	@echo '  - clean-deps    : Removes dependency files for tests. If tests stop building,'
	@echo '                    run this target.'
	@echo '  - clean-all     : Cleans up all of Stan.'
	@echo ''
	@echo '--------------------------------------------------------------------------------'

##
# Clean up.
##
MODEL_SPECS := $(call findfiles,src/test,*.stan)
.PHONY: clean clean-demo clean-dox clean-models clean-all clean-deps
clean:
	$(RM) $(call findfiles,src,*.dSYM) $(call findfiles,src,*.d.*)
	$(RM) $(wildcard $(MODEL_SPECS:%.stan=%.hpp))
	$(RM) $(wildcard $(MODEL_SPECS:%.stan=%$(EXE)))
	$(RM) $(wildcard $(MODEL_SPECS:%.stan=%.o))
	$(RM) $(wildcard $(MODEL_SPECS:%.stan=%.d))

clean-dox:
	$(RM) -r doc/api

clean-deps:
	@echo '  removing dependency files'
	$(RM) $(call findfiles,./,*.d)

clean-all: clean clean-dox clean-deps clean-libraries
	$(RM) -r test bin
	@echo '  removing .o files'
	$(RM) $(call findfiles,src/,*.o)

##
# Submodule related tasks
##
.PHONY: math-revert
math-revert:
	git submodule update --init --recursive

.PHONY: math-update
math-update:
	git submodule init
	git submodule update --recursive

math-update/%: math-update
	cd $(MATH) && git fetch --all && git checkout $* && git pull

##
# Debug target that allows you to print a variable
##
print-%  : ; @echo $* = $($*)