summary refs log tree commit diff
path: root/lib/lufa/Maintenance
diff options
context:
space:
mode:
authorFabian Topfstedt <topfstedt@schneevonmorgen.com>2017-07-20 08:22:44 +0200
committerFabian Topfstedt <topfstedt@schneevonmorgen.com>2017-07-20 08:22:44 +0200
commitee43856ff7ba37ea89d1a8a4700efba4e4f69571 (patch)
treeb0ed5b538396b0b2b027e69ad8ceac443c067c79 /lib/lufa/Maintenance
parent99b6e918eab31d4f53cabc04a995da945335ac7f (diff)
parent14c5160b1a94d5dc416002791b3c207ba0dca789 (diff)
Merge https://github.com/qmk/qmk_firmware
Diffstat (limited to 'lib/lufa/Maintenance')
-rw-r--r--lib/lufa/Maintenance/lufa_functionlist_transform.xslt19
-rw-r--r--lib/lufa/Maintenance/makefile94
2 files changed, 113 insertions, 0 deletions
diff --git a/lib/lufa/Maintenance/lufa_functionlist_transform.xslt b/lib/lufa/Maintenance/lufa_functionlist_transform.xslt
new file mode 100644
index 0000000000..b18f69f2d4
--- /dev/null
+++ b/lib/lufa/Maintenance/lufa_functionlist_transform.xslt
@@ -0,0 +1,19 @@
+<!--
+             LUFA Library
+     Copyright (C) Dean Camera, 2017.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+-->
+
+<!-- Extracts out all function signatures from a combined Doxygen XML output. -->
+
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+	<xsl:output method="xml" omit-xml-declaration="yes"/>
+
+	<xsl:template match="doxygen">
+		<xsl:for-each select="//memberdef[@kind = 'function']">
+			<xsl:value-of select="definition"/><xsl:value-of select="argsstring"/><xsl:text>;&#10;</xsl:text>
+		</xsl:for-each>
+	</xsl:template>
+</xsl:stylesheet>
diff --git a/lib/lufa/Maintenance/makefile b/lib/lufa/Maintenance/makefile
new file mode 100644
index 0000000000..93f694e436
--- /dev/null
+++ b/lib/lufa/Maintenance/makefile
@@ -0,0 +1,94 @@
+#
+#             LUFA Library
+#     Copyright (C) Dean Camera, 2017.
+#
+#  dean [at] fourwalledcubicle [dot] com
+#           www.lufa-lib.org
+#
+
+# Maintenance scripts not required by general LUFA users, used for project development purposes.
+
+
+# Path to the root of the LUFA tree
+LUFA_ROOT := ../
+
+all:
+
+# Print a list of all filenames and line numbers that exceed an allowed threshold
+line-lengths:
+	awk '{ if (length > 120) { print FILENAME, ":", FNR, "[", length, "]" } }' `find $(LUFA_ROOT) -name *.[ch]`
+
+# Generate a header containing all library functions
+function-list:
+	$(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT))/LUFA doxygen DOXYGEN_OVERRIDE_PARAMS="GENERATE_HTML=no GENERATE_XML=yes"
+	@xsltproc $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Documentation/xml/combine.xslt $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Documentation/xml/index.xml > temp.xml
+	@xsltproc lufa_functionlist_transform.xslt temp.xml > function_list.h
+	@sort function_list.h | uniq > function_list_unique.h
+	@rm temp.xml
+
+# Update all Doxygen configuration files to the latest Doxygen version
+upgrade-doxygen:
+	@echo Upgrading Doxygen files...
+	@for doxygen_conf in `find $(LUFA_ROOT) -name doxyfile`; do \
+	  doxygen -u $$doxygen_conf;                                \
+	done;
+	@echo Doxygen configuration update complete.
+
+# Make all possible bootloaders for all targets and configurations as set by the BootloaderTest build test
+# and store them in a separate directory called "Bootloaders"
+bootloaders:
+	@echo "build_bootloaders:" > BuildMakefile
+	@printf "\t-mkdir Bootloaders 2>/dev/null\n\n" >> BuildMakefile
+
+	@while read line;                                         \
+	 do                                                       \
+	   build_cfg=`echo $$line | grep -v "#" | sed 's/ //g'`;  \
+	                                                          \
+	   if ( test -n "$$build_cfg" ); then                     \
+	     build_bootloader=`echo $$build_cfg | cut -d'=' -f1`; \
+		 build_cfg=`echo $$build_cfg | cut -d'=' -f2-`;       \
+		                                                      \
+	     build_arch=`echo $$build_cfg | cut -d':' -f1`;       \
+	     build_mcu=`echo $$build_cfg | cut -d':' -f2`;        \
+	     build_board=`echo $$build_cfg | cut -d':' -f3`;      \
+	     build_flashsize=`echo $$build_cfg | cut -d':' -f4`;  \
+	     build_bootsize=`echo $$build_cfg | cut -d':' -f5`;   \
+	     build_fusb=`echo $$build_cfg | cut -d':' -f6`;       \
+	                                                          \
+	     printf "Found '%s' with FLASH: %3s KB, BOOT: %3s KB, MCU: %12s / %4s, BOARD: %s, F_USB: %sMHz\n" $$build_bootloader $$build_flashsize $$build_bootsize $$build_mcu $$build_arch $$build_board $$build_fusb; \
+	                                                          \
+	     printf "\t-mkdir Bootloaders/%s 2>/dev/null\n" $$build_bootloader >> BuildMakefile; \
+	     printf "\t@echo Building '%s' with FLASH: %3s KB, BOOT: %3s KB, MCU: %12s, BOARD: %s, F_USB: %sMHz\n" $$build_bootloader $$build_flashsize $$build_bootsize $$build_mcu $$build_board $$build_fusb >> BuildMakefile; \
+	     printf "\t$(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT))/Bootloaders/%s/ clean hex ARCH=%s MCU=%s BOARD=%s FLASH_SIZE_KB=%s BOOT_SECTION_SIZE_KB=%s F_USB=%s000000 DEBUG_LEVEL=0\n" $$build_bootloader $$build_arch $$build_mcu $$build_board $$build_flashsize $$build_bootsize $$build_fusb >> BuildMakefile; \
+		 printf "\tmv $(patsubst %/,%,$(LUFA_ROOT))/Bootloaders/%s/Bootloader%s.hex Bootloaders/%s/%s-%s-%s-BOARD_%s-BOOT_%sKB-%sMHz.hex\n\n" $$build_bootloader $$build_bootloader $$build_bootloader $$build_bootloader $$build_arch $$build_mcu $$build_board $$build_bootsize $$build_fusb >> BuildMakefile; \
+	   fi;                                                    \
+	 done < $(patsubst %/,%,$(LUFA_ROOT))/BuildTests/BootloaderTest/BootloaderDeviceMap.cfg
+
+	 $(MAKE) -f BuildMakefile build_bootloaders
+	 cp $(patsubst %/,%,$(LUFA_ROOT))/LUFA/License.txt Bootloaders
+	 rm -f BuildMakefile
+
+# Check the working branch documentation, ensure no placeholder values
+check-documentation-placeholders:
+	@echo Checking for release suitability...
+	@if ( grep " LUFA_VERSION_RELEASE_TYPE " $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Version.h | grep "LUFA_VERSION_RELEASE_TYPE_DEVELOPMENT" > /dev/null ;); then          \
+	  echo "  ERROR: Version header has not been updated for release!";           \
+	  exit 1;                                                                     \
+	fi;
+	@if ( grep "XXXXXX" $(patsubst %/,%,$(LUFA_ROOT))/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
+	  echo "  ERROR: Doxygen documentation has not been updated for release!";    \
+	  exit 1;                                                                     \
+	fi;
+	@echo Done.
+
+# Validate the working branch - compile all documentation, demos/projects/examples and run build tests
+validate-branch:
+	$(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT)) doxygen
+	$(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT)) all DEBUG_LEVEL=0
+	$(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT))/BuildTests all
+
+# Validate the working branch for general release, check for placeholder documentation then build and test everything
+validate-release: check-documentation-placeholders validate-branch
+
+
+.PHONY: all upgrade-doxygen bootloaders check-documentation-placeholders validate-branch