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 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 # Check the working branch documentation, ensure no placeholder values
  27 check-documentation-placeholders:
  28         @echo Checking for release suitability...
  29         @if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \
  30           echo "  ERROR: Doxygen documentation has not been updated for release!"; \
  31           exit 1; \
  32         fi;
  33         @if ( grep "000000" $(LUFA_ROOT)/LUFA/Version.h > /dev/null ;); then \
  34           echo "  ERROR: Version header has not been updated for release!"; \
  35           exit 1; \
  36         fi;
  37         @echo Done.
  38
  39 # Test all generated documentation for any bad links
  40 check-documentation-links:
  41         @for html_file in `find $(LUFA_ROOT) -name *.html`; do \
  42                 echo Checking $$html_file...; \
  43                 cat $$html_file | grep -v "doxygen.org" | grep -v "fourwalledcubicle.com" | wget -nv --referer=www.lufa-lib.org --user-agent="lufa-link-check-script" -B $(dir $$html_file) --spider --force-html --input-file=-; \
  44         done;
  45
  46 # Validate the working branch - compile all documentation, demos/projects/examples and run build tests
  47 validate-branch:
  48         make -s -C $(LUFA_ROOT) doxygen
  49         make -s -C $(LUFA_ROOT) all
  50         make -s -C $(LUFA_ROOT)/BuildTests all
  51
  52 # Validate the working branch for general release, check for placeholder documentation then build and test everything
  53 validate-release: check-documentation-placeholders validate-branch