Minor documentation improvements.

[pub/USBasp.git] / Maintenance / makefile

diff --git a/Maintenance/makefile b/Maintenance/makefile
index 87a8b9e..5cce2bf 100644 (file)
--- a/Maintenance/makefile
+++ b/Maintenance/makefile
@@ -6,23 +6,48 @@
 #           www.lufa-lib.org\r
 #\r
 \r
-# Maintenance scripts not required by general LUFA users, used for development.\r
+# Maintenance scripts not required by general LUFA users, used for project development purposes.\r
 \r
 LUFA_ROOT = ../\r
 \r
+all:\r
+\r
+\r
+# Update all Doxygen configuration files to the latest Doxygen version - force Markdown support to be disabled\r
 upgrade-doxygen:\r
-       @echo Updating Doxygen.conf files...\r
+       @echo Upgrading Doxygen.conf files...\r
        @for doxygen_conf in `find $(LUFA_ROOT) -name Doxygen.conf`; do \\r
          doxygen -u $$doxygen_conf; \\r
+         sed "s/MARKDOWN_SUPPORT *= *YES/MARKDOWN_SUPPORT       = NO/1" $$doxygen_conf > $$doxygen_conf.new; \\r
+         mv -u $$doxygen_conf.new $$doxygen_conf; \\r
        done;\r
        @echo Doxygen configuration update complete.\r
-       \r
-check-release:\r
+\r
+# Check the working branch documentation, ensure no placeholder values\r
+check-documentation-placeholders:\r
        @echo Checking for release suitability...\r
        @if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \\r
          echo "  ERROR: Doxygen documentation has not been updated for release!"; \\r
+         exit 1; \\r
        fi;\r
        @if ( grep "000000" $(LUFA_ROOT)/LUFA/Version.h > /dev/null ;); then \\r
          echo "  ERROR: Version header has not been updated for release!"; \\r
+         exit 1; \\r
        fi;\r
        @echo Done.\r
+\r
+# Test all generated documentation for any bad links\r
+check-documentation-links:\r
+       @for html_file in `find $(LUFA_ROOT) -name *.html`; do \\r
+               echo Checking $$html_file...; \\r
+               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=-; \\r
+       done;\r
+\r
+# Validate the working branch - compile all documentation, demos/projects/examples and run build tests\r
+validate-branch:\r
+       make -s -C $(LUFA_ROOT) doxygen\r
+       make -s -C $(LUFA_ROOT) all     \r
+       make -s -C $(LUFA_ROOT)/BuildTests all\r
+\r
+# Validate the working branch for general release, check for placeholder documentation then build and test everything\r
+validate-release: check-documentation-placeholders validate-branch\r