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_files="$$source_files<SOURCEFILE>`basename $$c_source_file`<\/SOURCEFILE>"; \
  44                   gcc_source_files="$$gcc_source_files<Name>`basename $$c_source_file`<\/Name>"; \
  45                 done; \
  46                 for c_header_file in `find $$target_folder -name *.h`; do \
  47                   source_files="$$source_files<HEADERFILE>`basename $$c_header_file`<\/HEADERFILE>"; \
  48                   gcc_source_files="$$gcc_source_files<Name>`basename $$c_header_file`<\/Name>"; \
  49                 done; \
  50                 for assembly_file in `find $$target_folder -name *.S`; do \
  51                   source_files="$$source_files<OTHERFILE>`basename $$assembly_file`<\/OTHERFILE>"; \
  52                   gcc_source_files="$$gcc_source_files<Name>`basename $$assembly_file`<\/Name>"; \
  53                 done; \
  54                 \
  55             sed "s/%TARGET%/$$target_name/g" AS4Template.aps > $$target_folder/$$target_name.aps.new; \
  56             sed "s/%CREATED%/$$as4_date/g" $$target_folder/$$target_name.aps.new > $$target_folder/$$target_name.aps.new2; \
  57             sed "s/%FILE_LIST%/$$source_files/g" $$target_folder/$$target_name.aps.new2 > $$target_folder/$$target_name.aps.new3; \
  58             sed "s/%GCC_FILE_LIST%/$$gcc_source_files/g" $$target_folder/$$target_name.aps.new3 > $$target_folder/$$target_name.aps.new4; \
  59                 mv $$target_folder/$$target_name.aps.new4 $$target_folder/$$target_name.aps; \
  60                 rm $$target_folder/$$target_name.aps.new $$target_folder/$$target_name.aps.new2 $$target_folder/$$target_name.aps.new3; \
  61           fi; \
  62         done;
  63         @echo AVR Studio 4 project generation complete.
  64
  65 # Check the working branch documentation, ensure no placeholder values
  66 check-documentation-placeholders:
  67         @echo Checking for release suitability...
  68         @if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
  69           echo "  ERROR: Doxygen documentation has not been updated for release!"; \
  70           exit 1; \
  71         fi;
  72         @if ( grep "000000" $(LUFA_ROOT)/LUFA/Version.h > /dev/null ;); then \
  73           echo "  ERROR: Version header has not been updated for release!"; \
  74           exit 1; \
  75         fi;
  76         @echo Done.
  77
  78 # Validate the working branch - compile all documentation, demos/projects/examples and run build tests
  79 validate-branch:
  80         make -s -C $(LUFA_ROOT) doxygen
  81         make -s -C $(LUFA_ROOT) all
  82         make -s -C $(LUFA_ROOT)/BuildTests all
  83
  84 # Validate the working branch for general release, check for placeholder documentation then build and test everything
  85 validate-release: check-documentation-placeholders validate-branch