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