Add a distcheck Makefile target
[pyxattr.git] / Makefile
1 PYTHON        = python3
2 SPHINXOPTS    = -W
3 SPHINXBUILD   = $(PYTHON) -m sphinx
4 DOCDIR        = doc
5 DOCHTML       = $(DOCDIR)/html
6 DOCTREES      = $(DOCDIR)/doctrees
7 ALLSPHINXOPTS = -d $(DOCTREES) $(SPHINXOPTS) $(DOCDIR)
8 VERSION       = 0.6.1
9 FULLVER       = pyxattr-$(VERSION)
10 DISTFILE      = $(FULLVER).tar.gz
11
12 MODNAME = xattr.so
13 RSTFILES = doc/index.rst doc/module.rst doc/news.rst doc/readme.md doc/conf.py
14 PYVERS = 2.4 2.5 2.6 2.7 3.0 3.1 3.2 3.3 3.4 3.5 3.6 3.7
15 REPS = 5
16
17 all: doc test
18
19 $(MODNAME): xattr.c
20         $(PYTHON) ./setup.py build_ext --inplace
21
22 $(DOCHTML)/index.html: $(MODNAME) $(RSTFILES)
23         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCHTML)
24         touch $@
25
26 doc: $(DOCHTML)/index.html
27
28 doc/readme.md: README.md
29         ln -s ../README.md doc/readme.md
30
31 doc/news.rst: NEWS
32         ln -s ../NEWS doc/news.rst
33
34 dist:
35         fakeroot $(PYTHON) ./setup.py sdist
36
37 distcheck: dist
38         set -e; \
39         TDIR=$$(mktemp -d) && \
40         trap "rm -rf $$TDIR" EXIT; \
41         tar xzf dist/$(DISTFILE) -C $$TDIR && \
42         (cd $$TDIR/$(FULLVER) && make doc && make test && make dist) && \
43         echo "All good, you can upload $(DISTFILE)!"
44
45 test:
46         @for ver in $(PYVERS); do \
47           for flavour in "" "-dbg"; do \
48             if type python$$ver$$flavour >/dev/null; then \
49               echo Testing with python$$ver$$flavour; \
50               python$$ver$$flavour ./setup.py test -q; \
51             fi; \
52           done; \
53         done;
54         @if type pypy >/dev/null; then \
55           echo Testing with pypy; \
56           pypy ./setup.py test -q; \
57         fi
58
59 benchmark: $(MODNAME)
60         @set -e; \
61         TESTFILE=`mktemp`;\
62         trap 'rm $$TESTFILE' EXIT; \
63         for ver in $(PYVERS) ; do \
64             if type python$$ver >/dev/null; then \
65               echo Benchmarking with python$$ver; \
66               python$$ver ./setup.py build -q; \
67               echo "  - set (with override)"; \
68               python$$ver -m timeit -r $(REPS) -s 'import xattr' "xattr.set('$$TESTFILE', 'user.comment', 'hello')"; \
69               echo "  - list"; \
70               python$$ver -m timeit -r $(REPS) -s 'import xattr' "xattr.list('$$TESTFILE')"; \
71               echo "  - get"; \
72               python$$ver -m timeit -r $(REPS) -s 'import xattr' "xattr.get('$$TESTFILE', 'user.comment')"; \
73               echo "  - set + remove"; \
74               python$$ver -m timeit -r $(REPS) -s 'import xattr' "xattr.set('$$TESTFILE', 'user.comment', 'hello'); xattr.remove('$$TESTFILE', 'user.comment')"; \
75             fi; \
76         done;
77
78 coverage:
79         $(MAKE) clean
80         $(MAKE) test CFLAGS="-coverage"
81         lcov --capture --directory . --output-file coverage.info
82         genhtml coverage.info --output-directory out
83
84 clean:
85         rm -rf $(DOCHTML) $(DOCTREES)
86         rm -f doc/readme.md doc/news.rst
87         rm -f $(MODNAME)
88         rm -f *.so
89         rm -rf build
90
91 .PHONY: doc test clean dist distcheck coverage