ccanlint: Understand Creative Commons Zero license.
[ccan] / Makefile
index 222a9b22146c516476d9ae2ae816a00636c5ad25..13aa195dd0e379187a34d5470d927177f89c7c13 100644 (file)
--- a/Makefile
+++ b/Makefile
-# Hacky makefile to compile everything and run the tests in some kind of sane order.
-# V=--verbose for verbose tests.
-
-# This can be overridden on cmdline to generate pages elsewhere.
-WEBDIR=~/www/html/ccan/
-
-ALL=$(patsubst ccan/%/test, %, $(wildcard ccan/*/test))
-ALL_DIRS=$(patsubst %, ccan/%, $(ALL))
-ALL_DEPENDS=$(patsubst %, ccan/%/.depends, $(ALL))
-ALL_PAGES=$(patsubst ccan/%, $(WEBDIR)/info/%.html, $(ALL_DIRS))
-DIRECT_TARBALLS=$(patsubst ccan/%, $(WEBDIR)/tarballs/%.tar.bz2, $(ALL_DIRS))
-DEPEND_TARBALLS=$(patsubst ccan/%, $(WEBDIR)/tarballs/with-deps/%.tar.bz2, $(ALL_DIRS))
-WEB_SUBDIRS=$(WEBDIR)/tarballs $(WEBDIR)/junkcode $(WEBDIR)/tarballs/with-deps $(WEBDIR)/info
-JUNKDIRS=$(wildcard junkcode/*)
-JUNKPAGES=$(JUNKDIRS:%=$(WEBDIR)/%.html)
-JUNKBALLS=$(JUNKDIRS:%=$(WEBDIR)/%.tar.bz2)
+# Hacky makefile to compile everything and run the tests in some kind
+# of sane order.
+
+# Main targets:
+# 
+# check: run tests on all ccan modules (use 'make check V=--verbose' for more)
+#        Includes building libccan.a.
+# libccan.a: A library with all the ccan modules in it.
+# tools: build useful tools in tools/ dir.
+#        Especially tools/ccanlint/ccanlint and tools/namespacize.
+# distclean: destroy everything back to pristine state
+
+# Trying to build the whole repo is usually a lose; there will be some
+# dependencies you don't have.
+EXCLUDE=wwviaudio ogg_to_pcm jmap jset nfs
+
+# Where make scores puts the results
+SCOREDIR=scores/$(shell whoami)/$(shell uname -s)-$(shell uname -m)-$(CC)-$(shell git describe --always --dirty)
+
+ALL=$(filter-out $(EXCLUDE), $(REALLY_ALL))
+
+ALL_DEPENDS=$(patsubst %, ccan/%/.depends, $(REALLY_ALL))
+
+# Not all modules have tests.
+ALL_TESTS=$(patsubst ccan/%/test/, %, $(foreach dir, $(ALL), $(wildcard ccan/$(dir)/test/)))
+
+# Here's my rough logarithmic timeout graph for my laptop:
+#
+# 302                                                  -     
+#    |                                                  / --*  
+#    |                                                 /       
+#    |                                                 /       
+#    |                                                /        
+#    |Execution Time, seconds                        /        
+#    |                                               /         
+#    |                                          ---//          
+#    |                                         /               
+#    |                                       //                
+#    |                    ---\            ---                  
+#    |                 ---    \\    ------                     
+#    |-----------------         \---                           
+# 19 +------------------------------------------------------+--
+#    0           Timeout (ms, logarithmic)               262144
+#
+# 140
+#    |                                                         
+#    |------------                                             
+#    |            ---                                          
+#    |               ---------                                 
+#    |                        -------                          
+#    |                               --\                       
+#    |                                  \\-                    
+#    | Tests skipped                       --\                 
+#    |                                        \                
+#    |                                         \\              
+#    |                                           \\\           
+#    |                                              \          
+#    |                                               \----     
+#  --+0---------------------------------------------------==+--
+#    0           Timeout (ms, logarithmic)               262144
+#
+# On my laptop, this runs 574 tests in 40 seconds, vs. a full check which
+# runs 676 tests in 260 seconds.
+FASTTIMEOUT=750
+
+default: libccan.a
 
 include Makefile-ccan
 
-check: $(ALL_DIRS:%=test-%)
-       echo $(ALL_DIRS)
+fastcheck: $(ALL_TESTS:%=summary-fastcheck-%)
+
+check: $(ALL_TESTS:%=summary-check-%)
 
 distclean: clean
        rm -f $(ALL_DEPENDS)
-       rm -rf $(WEBDIR)
-
-webpages: $(WEB_SUBDIRS) $(WEBDIR)/junkcode $(ALL_PAGES) $(WEBDIR)/list.html $(WEBDIR)/index.html $(WEBDIR)/upload.html $(WEBDIR)/uploader.php $(WEBDIR)/example-config.h $(WEBDIR)/ccan.jpg $(DIRECT_TARBALLS) $(DEPEND_TARBALLS) $(WEBDIR)/ccan.tar.bz2 $(WEBDIR)/Makefile-ccan $(JUNKPAGES) $(JUNKBALLS)
-
-$(WEB_SUBDIRS):
-       mkdir -p $@
-
-$(WEBDIR)/junkcode/%.tar.bz2: junkcode/% $(WEBDIR)/junkcode
-       tar cvfj $@ `bzr ls --versioned --kind=file $<`
-
-$(WEBDIR)/junkcode/%.html: $(WEBDIR)/junkcode/%.tar.bz2
-       cd $(WEBDIR) && tar xfj junkcode/$*.tar.bz2
-       php5 web/staticjunkcode.php junkcode/$* $* > $@
-
-# Override implicit attempt to link directory.
-$(ALL_DIRS):
-       @touch $@
-
-$(WEBDIR)/ccan.tar.bz2:
-       tar cvfj $@ `bzr ls --versioned --kind=file ccan`
-
-$(ALL_PAGES): tools/doc_extract web/staticmoduleinfo.php
 
-$(WEBDIR)/list.html: web/staticall.php tools/doc_extract $(DIRECT_TARBALLS) $(DEPEND_TARBALLS) $(WEBDIR)/ccan.tar.bz2 $(JUNKBALLS)
-       php5 web/staticall.php ccan/ junkcode/ $(WEBDIR) > $@
+scores: $(SCOREDIR)/SUMMARY
 
-$(WEBDIR)/upload.html: web/staticupload.php
-       php5 web/staticupload.php > $@
+$(SCOREDIR)/SUMMARY: $(patsubst ccan/%/_info, $(SCOREDIR)/score-%, $(wildcard ccan/*/_info))
+       git describe --always > $@
+       uname -a >> $@
+       $(CC) -v >> $@
+       cat $^ | grep 'Total score:' >> $@
 
-# cpp inserts gratuitous linebreaks at start of file, makes for php problems.
-$(WEBDIR)/uploader.php: web/uploader.php.cpp
-       cpp -w -C -P $< | grep . > $@
+$(SCOREDIR)/score-%: ccan/%/_info tools/ccanlint/ccanlint $(OBJFILES)
+       mkdir -p $(SCOREDIR)
+       tools/ccanlint/ccanlint -v -s ccan/$* > $@ || true
 
-$(WEBDIR)/index.html: web/staticindex.php
-       php5 web/staticindex.php > $@
-
-$(WEBDIR)/example-config.h: config.h
-       cp $< $@
-
-$(WEBDIR)/Makefile-ccan: Makefile-ccan
-       cp $< $@
-
-$(WEBDIR)/ccan.jpg: web/ccan.jpg
-       cp $< $@
-
-$(WEBDIR)/info/%.html: ccan/% ccan/%/test $(WEBDIR)/tarballs/%.tar.bz2 $(WEBDIR)/tarballs/with-deps/%.tar.bz2
-       URLPREFIX=../ php5 web/staticmoduleinfo.php ccan/$* > $@
+$(ALL_DEPENDS): %/.depends: %/_info tools/ccan_depends
+       tools/ccan_depends $* > $@ || ( rm -f $@; exit 1 )
 
-$(WEBDIR)/tarballs/%.tar.bz2: ccan/% ccan/%/test
-       tar -c -v -j -f $@ `bzr ls --versioned --kind=file ccan/$*`
+# Actual dependencies are created in inter-depends
+check-%: tools/ccanlint/ccanlint
+       tools/ccanlint/ccanlint ccan/$*
 
-$(WEBDIR)/tarballs/with-deps/%.tar.bz2: ccan/% ccan/%/test tools/ccan_depends
-       tar cvfj $@ $$(echo ccan/$* $$(tools/ccan_depends ccan/$*) | xargs -n 1 bzr ls --versioned --kind=file)
+fastcheck-%: tools/ccanlint/ccanlint
+       tools/ccanlint/ccanlint --timeout $(FASTTIMEOUT) ccan/$*
 
-$(ALL_DEPENDS): %/.depends: tools/ccan_depends
-       tools/ccan_depends $* > $@ || ( rm -f $@; exit 1 )
+# Doesn't test dependencies, doesn't print verbose fail results.
+summary-check-%: tools/ccanlint/ccanlint $(OBJFILES)
+       tools/ccanlint/ccanlint -s ccan/$*
 
-test-ccan/%: tools/run_tests libccan.a(%.o)
-       @echo Testing $*...
-       @if tools/run_tests $(V) ccan/$* | grep ^'not ok'; then exit 1; else exit 0; fi
+summary-fastcheck-%: tools/ccanlint/ccanlint $(OBJFILES)
+       tools/ccanlint/ccanlint -x tests_pass_valgrind -x tests_compile_coverage -s ccan/$*
 
-# Some don't have object files.
-test-ccan/%:: tools/run_tests
-       @echo Testing $*...
-       @if tools/run_tests $(V) ccan/$* | grep ^'not ok'; then exit 1; else exit 0; fi
+ccan/%/info: ccan/%/_info
+       $(CC) $(CCAN_CFLAGS) -o $@ -x c $<
 
-ccanlint: tools/ccanlint/ccanlint
+libccan.a(%.o): ccan/%.o
+       $(AR) r $@ $<
 
 clean: tools-clean
-       $(RM) `find . -name '*.o'` `find . -name '.depends'` `find . -name '*.a'`  `find . -name _info`
-       $(RM) inter-depends lib-depends test-depends
+       $(RM) `find * -name '*.o'` `find * -name '.depends'` `find * -name '*.a'`  `find * -name info` `find * -name '*.d'`
+       $(RM) inter-depends lib-depends test-depends ccan/*-Makefile
+
+# Creates a dependency from the tests to the object files which it needs.
+inter-depends: $(ALL_DEPENDS) Makefile
+       for f in $(ALL_DEPENDS); do echo check-$$(basename $$(dirname $$f) ): $$(for dir in $$(cat $$f) $$(dirname $$f); do [ "$$(echo $$dir/*.c)" = "$$dir/*.c" ] || echo ccan/"$$(basename $$dir)".o; done); done > $@
 
-# Only list a dependency if there are object files to build.
-inter-depends: $(ALL_DEPENDS)
-       for f in $(ALL_DEPENDS); do echo test-ccan/$$(basename $$(dirname $$f) ): $$(for dir in $$(cat $$f); do [ "$$(echo $$dir/[a-z]*.c)" = "$$dir/[a-z]*.c" ] || echo libccan.a\("$$(basename $$dir)".o\); done); done > $@
+# Creates dependencies between tests, so if foo depends on bar, bar is tested
+# first 
+test-depends: $(ALL_DEPENDS) Makefile
+       for f in $(ALL_DEPENDS); do echo check-`basename \`dirname $$f\``: `sed -n 's,ccan/\(.*\),check-\1,p' < $$f`; done > $@
 
-test-depends: $(ALL_DEPENDS)
-       for f in $(ALL_DEPENDS); do echo test-ccan/`basename \`dirname $$f\``: `sed -n 's,ccan/\(.*\),test-ccan/\1,p' < $$f`; done > $@
+# Ensure we don't end up with empty file if configurator fails!
+config.h: tools/configurator/configurator Makefile Makefile-ccan
+       tools/configurator/configurator $(CC) $(CCAN_CFLAGS) > $@ || rm -f $@
 
 include tools/Makefile
 -include inter-depends
 -include test-depends
+-include Makefile-web