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 development.
  10
  11 LUFA_ROOT = ../
  12
  13 all:
  14
  15
  16 # Update all Doxygen configuration files to the latest Doxygen version - force Markdown support to be disabled
  17 upgrade-doxygen:
  18         @echo Upgrading Doxygen.conf files...
  19         @for doxygen_conf in `find $(LUFA_ROOT) -name Doxygen.conf`; do \
  20           doxygen -u $$doxygen_conf; \
  21           sed "s/MARKDOWN_SUPPORT *= *YES/MARKDOWN_SUPPORT       = NO/1" $$doxygen_conf > $$doxygen_conf.new; \
  22           mv -u $$doxygen_conf.new $$doxygen_conf; \
  23         done;
  24         @echo Doxygen configuration update complete.
  25
  26 # Validate the working branch - compile all documentation, demos/projects/examples and run build tests
  27 validate-branch:
  28         make -s -C $(LUFA_ROOT) doxygen
  29         make -s -C $(LUFA_ROOT) all
  30         make -s -C $(LUFA_ROOT)/BuildTests all
  31
  32 # Check the working branch documentation, ensure no placeholder values
  33 check-documentation-placeholders:
  34         @echo Checking for release suitability...
  35         @if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
  36           echo "  ERROR: Doxygen documentation has not been updated for release!"; \
  37           exit 1; \
  38         fi;
  39         @if ( grep "000000" $(LUFA_ROOT)/LUFA/Version.h > /dev/null ;); then \
  40           echo "  ERROR: Version header has not been updated for release!"; \
  41           exit 1; \
  42         fi;
  43         @echo Done.
  44
  45 # Validate the working branch for general release, check for placeholder documentation then build and test everything
  46 validate-release: check-documentation-placeholders validate-branch