Upgrade doxygen configuration files to the latest version.
[pub/lufa.git] / Maintenance / makefile
index 41fb991..4d172eb 100644 (file)
@@ -1,91 +1,81 @@
-#\r
-#             LUFA Library\r
-#     Copyright (C) Dean Camera, 2012.\r
-#\r
-#  dean [at] fourwalledcubicle [dot] com\r
-#           www.lufa-lib.org\r
-#\r
-\r
-# Maintenance scripts not required by general LUFA users, used for project development purposes.\r
-\r
-\r
-# Path to the root of the LUFA tree\r
-LUFA_ROOT = ../\r
-\r
-all:\r
-\r
-# Update all Doxygen configuration files to the latest Doxygen version - force Markdown support to be disabled\r
-upgrade-doxygen:\r
-       @echo Upgrading Doxygen.conf files...\r
-       @for doxygen_conf in `find $(LUFA_ROOT) -name Doxygen.conf`; do                                       \\r
-         doxygen -u $$doxygen_conf;                                                                          \\r
-         sed "s/MARKDOWN_SUPPORT *= *YES/MARKDOWN_SUPPORT       = NO/1" $$doxygen_conf > $$doxygen_conf.new; \\r
-         sed "s/DISABLE_INDEX *= *NO/DISABLE_INDEX       = YES/1" $$doxygen_conf.new > $$doxygen_conf.new2;  \\r
-         mv -u $$doxygen_conf.new2 $$doxygen_conf;                                                           \\r
-         rm $$doxygen_conf.new;                                                                              \\r
-       done;\r
-       @echo Doxygen configuration update complete.\r
-\r
-# Generate AVR Studio 4 project files for each project from a template\r
-make-as4-projects:\r
-       @echo Creating AVR Studio 4 project files for Demos...\r
-       @for project_makefile in `find $(LUFA_ROOT)/Demos $(LUFA_ROOT)/Projects $(LUFA_ROOT)/Bootloaders -name makefile*`; do \\r
-         target_name=`grep "TARGET *=" $$project_makefile | cut -d'=' -f2 | sed 's/ //g'`; \\r
-         target_folder=`dirname $$project_makefile`;                                   \\r
-         as4_date=`date "+%e-%b-%Y %H:%M:%S"`;                                         \\r
-                                                                                       \\r
-         if ( test -n "$$target_name" ); then                                          \\r
-           echo Creating AS4 project for project $$target_name;                        \\r
-                                                                                       \\r
-           source_files="<OTHERFILE>`basename $$project_makefile`<\/OTHERFILE>";       \\r
-           gcc_source_files="";                                                        \\r
-           for c_source_file in `find $$target_folder -name *.c`; do                   \\r
-             source_filename=`basename $$c_source_file`;                               \\r
-                                                                                       \\r
-             source_files="$$source_files<SOURCEFILE>$$source_filename<\/SOURCEFILE>"; \\r
-             gcc_source_files="$$gcc_source_files<Name>$$source_filename<\/Name>";     \\r
-           done;                                                                       \\r
-           for c_header_file in `find $$target_folder -name *.h`; do                   \\r
-             source_filename=`basename $$c_header_file`;                               \\r
-                                                                                       \\r
-             source_files="$$source_files<HEADERFILE>$$source_filename<\/HEADERFILE>"; \\r
-             gcc_source_files="$$gcc_source_files<Name>$$source_filename<\/Name>";     \\r
-           done;                                                                       \\r
-           for assembly_file in `find $$target_folder -name *.S`; do                   \\r
-             source_filename=`basename $$assembly_file`;                               \\r
-                                                                                       \\r
-             source_files="$$source_files<OTHERFILE>$$source_filename<\/OTHERFILE>";   \\r
-             gcc_source_files="$$gcc_source_files<Name>$$source_filename<\/Name>";     \\r
-           done;                                                                       \\r
-                                                                                       \\r
-           sed "s/%TARGET%/$$target_name/g" AS4Template.aps > $$target_folder/$$target_name.aps.new;                                     \\r
-           sed "s/%CREATED%/$$as4_date/g" $$target_folder/$$target_name.aps.new > $$target_folder/$$target_name.aps.new2;                \\r
-           sed "s/%FILE_LIST%/$$source_files/g" $$target_folder/$$target_name.aps.new2 > $$target_folder/$$target_name.aps.new3;         \\r
-           sed "s/%GCC_FILE_LIST%/$$gcc_source_files/g" $$target_folder/$$target_name.aps.new3 > $$target_folder/$$target_name.aps.new4; \\r
-           mv $$target_folder/$$target_name.aps.new4 $$target_folder/$$target_name.aps;                                                  \\r
-           rm $$target_folder/$$target_name.aps.new $$target_folder/$$target_name.aps.new2 $$target_folder/$$target_name.aps.new3;       \\r
-         fi; \\r
-       done;\r
-       @echo AVR Studio 4 project generation complete.\r
-       \r
-# Check the working branch documentation, ensure no placeholder values\r
-check-documentation-placeholders:\r
-       @echo Checking for release suitability...\r
-       @if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \\r
-         echo "  ERROR: Doxygen documentation has not been updated for release!";    \\r
-         exit 1;                                                                     \\r
-       fi;\r
-       @if ( grep "000000" $(LUFA_ROOT)/LUFA/Version.h > /dev/null ;); then          \\r
-         echo "  ERROR: Version header has not been updated for release!";           \\r
-         exit 1;                                                                     \\r
-       fi;\r
-       @echo Done.\r
-\r
-# Validate the working branch - compile all documentation, demos/projects/examples and run build tests\r
-validate-branch:\r
-       make -C $(LUFA_ROOT) doxygen\r
-       make -C $(LUFA_ROOT) all\r
-       make -C $(LUFA_ROOT)/BuildTests all\r
-\r
-# Validate the working branch for general release, check for placeholder documentation then build and test everything\r
-validate-release: check-documentation-placeholders validate-branch\r
+#
+#             LUFA Library
+#     Copyright (C) Dean Camera, 2021.
+#
+#  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:
+
+# 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-release:
+       @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.
+
+.PHONY: all function-list upgrade-doxygen bootloaders check-release