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         @rm temp.xml
  23
  24 # Update all Doxygen configuration files to the latest Doxygen version - force Markdown support to be disabled
  25 upgrade-doxygen:
  26         @echo Upgrading Doxygen.conf files...
  27         @for doxygen_conf in `find $(LUFA_ROOT) -name Doxygen.conf`; do                                       \
  28           doxygen -u $$doxygen_conf;                                                                          \
  29         done;
  30         @echo Doxygen configuration update complete.
  31
  32 # Make all possible bootloaders for all targets and configurations as set by the BootloaderTest build test
  33 # and store them in a separate directory called "Bootloaders"
  34 bootloaders:
  35         @echo "build_bootloaders:" > BuildMakefile
  36         @printf "\t-mkdir Bootloaders 2>/dev/null\n\n" >> BuildMakefile
  37
  38         @while read line;                                         \
  39          do                                                       \
  40            build_cfg=`echo $$line | grep -v "#" | sed 's/ //g'`;  \
  41                                                                   \
  42            if ( test -n "$$build_cfg" ); then                     \
  43              build_bootloader=`echo $$build_cfg | cut -d'=' -f1`; \
  44                  build_cfg=`echo $$build_cfg | cut -d'=' -f2-`;       \
  45                                                                       \
  46              build_arch=`echo $$build_cfg | cut -d':' -f1`;       \
  47              build_mcu=`echo $$build_cfg | cut -d':' -f2`;        \
  48              build_board=`echo $$build_cfg | cut -d':' -f3`;      \
  49              build_flashsize=`echo $$build_cfg | cut -d':' -f4`;  \
  50              build_bootsize=`echo $$build_cfg | cut -d':' -f5`;   \
  51              build_fusb=`echo $$build_cfg | cut -d':' -f6`;       \
  52                                                                   \
  53              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; \
  54                                                                   \
  55              printf "\t-mkdir Bootloaders/%s 2>/dev/null\n" $$build_bootloader >> BuildMakefile; \
  56              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; \
  57              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; \
  58                  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; \
  59            fi;                                                    \
  60          done < $(patsubst %/,%,$(LUFA_ROOT))/BuildTests/BootloaderTest/BootloaderDeviceMap.cfg
  61
  62          $(MAKE) -f BuildMakefile build_bootloaders
  63          cp $(patsubst %/,%,$(LUFA_ROOT))/LUFA/License.txt Bootloaders
  64          rm -f BuildMakefile
  65
  66 # Check the working branch documentation, ensure no placeholder values
  67 check-documentation-placeholders:
  68         @echo Checking for release suitability...
  69         @if ( grep "XXXXXX" $(patsubst %/,%,$(LUFA_ROOT))/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
  70           echo "  ERROR: Doxygen documentation has not been updated for release!";    \
  71           exit 1;                                                                     \
  72         fi;
  73         @if ( grep "000000" $(patsubst %/,%,$(LUFA_ROOT))/LUFA/Version.h > /dev/null ;); then          \
  74           echo "  ERROR: Version header has not been updated for release!";           \
  75           exit 1;                                                                     \
  76         fi;
  77         @echo Done.
  78
  79 # Validate the working branch - compile all documentation, demos/projects/examples and run build tests
  80 validate-branch:
  81         $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT)) doxygen
  82         $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT)) all DEBUG_LEVEL=0
  83         $(MAKE) -C $(patsubst %/,%,$(LUFA_ROOT))/BuildTests all
  84
  85 # Validate the working branch for general release, check for placeholder documentation then build and test everything
  86 validate-release: check-documentation-placeholders validate-branch
  87
  88
  89 .PHONY: all upgrade-doxygen bootloaders check-documentation-placeholders validate-branch