Maintenance/makefile

   1 #
   2 #             LUFA Library
   3 #     Copyright (C) Dean Camera, 2013.
   4 #
   5 #  dean [at] fourwalledcubicle [dot] com
   6 #           www.lufa-lib.org
   7 #
   8
   9 # Maintenance scripts not required by general LUFA users, used for project development purposes.
  10
  11
  12 # Path to the root of the LUFA tree
  13 LUFA_ROOT := ../
  14
  15 all:
  16
  17 # Generate a header containing all library functions
  18 function-list:
  19         $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT))/LUFA doxygen DOXYGEN_OVERRIDE_PARAMS="GENERATE_HTML=no GENERATE_XML=yes"
  20         @xsltproc $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Documentation/xml/combine.xslt $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Documentation/xml/index.xml > temp.xml
  21         @xsltproc lufa_functionlist_transform.xslt temp.xml > function_list.h
  22         @cat function_list.h | sort | uniq > function_list_unique.h
  23         @rm temp.xml
  24
  25 # Update all Doxygen configuration files to the latest Doxygen version - force Markdown support to be disabled
  26 upgrade-doxygen:
  27         @echo Upgrading Doxygen.conf files...
  28         @for doxygen_conf in `find $(LUFA_ROOT) -name Doxygen.conf`; do                                       \
  29           doxygen -u $$doxygen_conf;                                                                          \
  30         done;
  31         @echo Doxygen configuration update complete.
  32
  33 # Make all possible bootloaders for all targets and configurations as set by the BootloaderTest build test
  34 # and store them in a separate directory called "Bootloaders"
  35 bootloaders:
  36         @echo "build_bootloaders:" > BuildMakefile
  37         @printf "\t-mkdir Bootloaders 2>/dev/null\n\n" >> BuildMakefile
  38
  39         @while read line;                                         \
  40          do                                                       \
  41            build_cfg=`echo $$line | grep -v "#" | sed 's/ //g'`;  \
  42                                                                   \
  43            if ( test -n "$$build_cfg" ); then                     \
  44              build_bootloader=`echo $$build_cfg | cut -d'=' -f1`; \
  45                  build_cfg=`echo $$build_cfg | cut -d'=' -f2-`;       \
  46                                                                       \
  47              build_arch=`echo $$build_cfg | cut -d':' -f1`;       \
  48              build_mcu=`echo $$build_cfg | cut -d':' -f2`;        \
  49              build_board=`echo $$build_cfg | cut -d':' -f3`;      \
  50              build_flashsize=`echo $$build_cfg | cut -d':' -f4`;  \
  51              build_bootsize=`echo $$build_cfg | cut -d':' -f5`;   \
  52              build_fusb=`echo $$build_cfg | cut -d':' -f6`;       \
  53                                                                   \
  54              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; \
  55                                                                   \
  56              printf "\t-mkdir Bootloaders/%s 2>/dev/null\n" $$build_bootloader >> BuildMakefile; \
  57              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; \
  58              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; \
  59                  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; \
  60            fi;                                                    \
  61          done < $(patsubst %/,%,$(LUFA_ROOT))/BuildTests/BootloaderTest/BootloaderDeviceMap.cfg
  62
  63          $(MAKE) -f BuildMakefile build_bootloaders
  64          cp $(patsubst %/,%,$(LUFA_ROOT))/LUFA/License.txt Bootloaders
  65          rm -f BuildMakefile
  66
  67 # Check the working branch documentation, ensure no placeholder values
  68 check-documentation-placeholders:
  69         @echo Checking for release suitability...
  70         @if ( grep "XXXXXX" $(patsubst %/,%,$(LUFA_ROOT))/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
  71           echo "  ERROR: Doxygen documentation has not been updated for release!";    \
  72           exit 1;                                                                     \
  73         fi;
  74         @if ( grep "000000" $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Version.h > /dev/null ;); then          \
  75           echo "  ERROR: Version header has not been updated for release!";           \
  76           exit 1;                                                                     \
  77         fi;
  78         @echo Done.
  79
  80 # Validate the working branch - compile all documentation, demos/projects/examples and run build tests
  81 validate-branch:
  82         $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT)) doxygen
  83         $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT)) all DEBUG_LEVEL=0
  84         $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT))/BuildTests all
  85
  86 # Validate the working branch for general release, check for placeholder documentation then build and test everything
  87 validate-release: check-documentation-placeholders validate-branch
  88
  89
  90 .PHONY: all upgrade-doxygen bootloaders check-documentation-placeholders validate-branch