Merge branch 'master' of eng-git.canterbury.ac.nz:mph/ucfk4

apps/pacerdemo1/doc/Makefile

@@ -0,0 +1,45 @@
+# File:   Makefile
+# Author: M. P. Hayes, UCECE
+# Date:   11 Sep 2010
+# Descr:  Makefile for pacerdemo1 docs
+
+# The scripts used to make the graphs require the program dot; this
+# is part of the graphviz package.
+
+DEL = rm
+
+all: file_dependencies.pdf module_dependencies.pdf makefile_dependencies.pdf build_dependencies.pdf callgraph.pdf
+
+file_dependencies.pdf: files.d 
+	../../../etc/graphdeps.py $< --out $@
+
+module_dependencies.pdf: modules.d 
+	../../../etc/graphdeps.py $< --modules --rotate --out $@
+
+makefile_dependencies.pdf: ../Makefile
+	../../../etc/graphdeps.py $< --out $@
+
+build_dependencies.pdf: ../Makefile
+	../../../etc/graphdeps.py $< --out $@ --showops
+
+callgraph.pdf: callgraph.d
+	../../../etc/graphdeps.py --calls --modules $< --out $@ --showops
+
+
+files.d: ../Makefile
+	(cd ..;	../../etc/makemake.py --relpath --files . . ../../drivers ../../drivers/avr ../../utils ../../extra --exclude system.h > doc/files.d)
+
+
+modules.d: ../Makefile
+	(cd ..;	../../etc/makemake.py --relpath --modules . . ../../drivers ../../drivers/avr ../../utils ../../extra --exclude system > doc/modules.d)
+
+
+callgraph.d: ../Makefile
+	(cd ..;	../../etc/makemake.py --cc="avr-gcc" --cflags="-Os -mmcu=atmega32u2" --relpath --calls . . ../../drivers ../../drivers/avr ../../utils ../../extra --exclude system.h > doc/callgraph.d)
+
+
+# Clean: delete derived files.
+.PHONY: clean
+clean: 
+	-$(DEL) *.d *.pdf
+

apps/pacerdemo1/doc/README

@@ -0,0 +1,16 @@
+Running make in this directory will generate a number of PDF graphs.
+In the callgraph, the arrows means "calls".  In the dependency graphs,
+the arrows means "requires" (or "depends upon").
+
+callgraph.pdf             This shows the callgraph, i.e., what functions each
+                          function in the program calls.
+module_dependencies.pdf   This shows the dependencies between the modules.
+file_dependencies.pdf     This shows the dependencies between the files.
+makefile_dependencies.pdf This shows the dependencies required by make when
+                          building the program.
+build_dependencies.pdf    This is like makefile_dependencies.pdf but shows
+                          the operations performed to generate the new file.
+
+callgraph.d               This shows the callgraph in text format.
+files.d                   This shows the file dependencies in text format.
+modules.d                 This shows the module dependencies in text format.