Maintenance/makefile

   1 #
   2 #             LUFA Library
   3 #     Copyright (C) Dean Camera, 2011.
   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 # Check the working branch documentation, ensure no placeholder values
  30 check-documentation-placeholders:
  31         @echo Checking for release suitability...
  32         @if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
  33           echo "  ERROR: Doxygen documentation has not been updated for release!"; \
  34           exit 1; \
  35         fi;
  36         @if ( grep "000000" $(LUFA_ROOT)/LUFA/Version.h > /dev/null ;); then \
  37           echo "  ERROR: Version header has not been updated for release!"; \
  38           exit 1; \
  39         fi;
  40         @echo Done.
  41
  42 # Validate the working branch - compile all documentation, demos/projects/examples and run build tests
  43 validate-branch:
  44         make -s -C $(LUFA_ROOT) doxygen
  45         make -s -C $(LUFA_ROOT) all
  46         make -s -C $(LUFA_ROOT)/BuildTests all
  47
  48 # Validate the working branch for general release, check for placeholder documentation then build and test everything
  49 validate-release: check-documentation-placeholders validate-branch