Maintenance/makefile

   1 #
   2 #             LUFA Library
   3 #     Copyright (C) Dean Camera, 2012.
   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 # Generate AVR Studio 4 project files for each project from a template
  30 make-as4-projects:
  31         @echo Creating AVR Studio 4 project files for Demos...
  32         @for project_makefile in `find $(LUFA_ROOT)/Demos $(LUFA_ROOT)/Projects $(LUFA_ROOT)/Bootloaders -name makefile*`; do \
  33           target_name=`grep "TARGET *=" $$project_makefile | cut -d'=' -f2 | sed 's/ //g'`; \
  34           target_folder=`dirname $$project_makefile`;                                   \
  35           as4_date=`date "+%-e-%b-%Y %-H:%-M:%-S"`;                                     \
  36                                                                                         \
  37           if ( test -n "$$target_name" ); then                                          \
  38             echo Creating AS4 project for project $$target_name;                        \
  39                                                                                         \
  40             source_files="<OTHERFILE>`basename $$project_makefile`<\/OTHERFILE>";       \
  41             gcc_source_files="";                                                        \
  42             for c_source_file in `find $$target_folder -name *.c`; do                   \
  43               source_filename=`basename $$c_source_file`;                               \
  44                                                                                         \
  45               source_files="$$source_files<SOURCEFILE>$$source_filename<\/SOURCEFILE>"; \
  46               gcc_source_files="$$gcc_source_files<Name>$$source_filename<\/Name>";     \
  47             done;                                                                       \
  48             for c_header_file in `find $$target_folder -name *.h`; do                   \
  49               source_filename=`basename $$c_header_file`;                               \
  50                                                                                         \
  51               source_files="$$source_files<HEADERFILE>$$source_filename<\/HEADERFILE>"; \
  52               gcc_source_files="$$gcc_source_files<Name>$$source_filename<\/Name>";     \
  53             done;                                                                       \
  54             for assembly_file in `find $$target_folder -name *.S`; do                   \
  55               source_filename=`basename $$assembly_file`;                               \
  56                                                                                         \
  57               source_files="$$source_files<OTHERFILE>$$source_filename<\/OTHERFILE>";   \
  58               gcc_source_files="$$gcc_source_files<Name>$$source_filename<\/Name>";     \
  59             done;                                                                       \
  60                                                                                         \
  61             sed "s/%TARGET%/$$target_name/g" AS4Template.aps > $$target_folder/$$target_name.aps.new;                                     \
  62             sed "s/%CREATED%/$$as4_date/g" $$target_folder/$$target_name.aps.new > $$target_folder/$$target_name.aps.new2;                \
  63             sed "s/%FILE_LIST%/$$source_files/g" $$target_folder/$$target_name.aps.new2 > $$target_folder/$$target_name.aps.new3;         \
  64             sed "s/%GCC_FILE_LIST%/$$gcc_source_files/g" $$target_folder/$$target_name.aps.new3 > $$target_folder/$$target_name.aps.new4; \
  65             mv $$target_folder/$$target_name.aps.new4 $$target_folder/$$target_name.aps;                                                  \
  66             rm $$target_folder/$$target_name.aps.new $$target_folder/$$target_name.aps.new2 $$target_folder/$$target_name.aps.new3;       \
  67           fi; \
  68         done;
  69         @echo AVR Studio 4 project generation complete.
  70
  71 # Check the working branch documentation, ensure no placeholder values
  72 check-documentation-placeholders:
  73         @echo Checking for release suitability...
  74         @if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
  75           echo "  ERROR: Doxygen documentation has not been updated for release!";    \
  76           exit 1;                                                                     \
  77         fi;
  78         @if ( grep "000000" $(LUFA_ROOT)/LUFA/Version.h > /dev/null ;); then          \
  79           echo "  ERROR: Version header has not been updated for release!";           \
  80           exit 1;                                                                     \
  81         fi;
  82         @echo Done.
  83
  84 # Validate the working branch - compile all documentation, demos/projects/examples and run build tests
  85 validate-branch:
  86         make -C $(LUFA_ROOT) doxygen
  87         make -C $(LUFA_ROOT) all
  88         make -C $(LUFA_ROOT)/BuildTests all
  89
  90 # Validate the working branch for general release, check for placeholder documentation then build and test everything
  91 validate-release: check-documentation-placeholders validate-branch