From 7d1ba179e84136abdc56a687c822aa3212a8946d Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Mon, 14 Nov 2016 22:25:34 -0500 Subject: [PATCH] Add some comments to the makefile. --- makefile | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/makefile b/makefile index 49c43ce..9c823dd 100644 --- a/makefile +++ b/makefile @@ -3,27 +3,36 @@ SRCS := $(PN)/*.py test/*.py # Sphinx tries to keep track of which docs need to be built on its # own. We could do better, but we would have to duplicate all of the -# information that we already gave Sphinx to make it work. +# information that we already gave Sphinx to make it work. Thus the +# "doc" target will unconditionally invoke sphinx. .PHONY: doc doc: cd doc && $(MAKE) html +# Run the doctests contained in the sphinx documentation, which aren't +# run as part of the normal test suite (because nobody wants to wait +# for sphinx to run). .PHONY: doctest doctest: cd doc && $(MAKE) doctest +# Run the test suite once. .PHONY: check check: PYTHONPATH="." test/__main__.py +# Run the test suite forever, but only the parts of it that are +# randomized. .PHONY: checkloop checkloop: PYTHONPATH="." test/__main__.py --no-doctests --loop +# Run pylint to obtain some unconstructive criticism on my coding style. .PHONY: lint lint: pylint --rcfile=./.pylintrc $(SRCS) +# Delete urrythang. .PHONY: clean clean: rm -rf $(PN)/__pycache__ test/__pycache__ doc/build -- 2.43.2