X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/915b4d234621298541f30d5cbaa14803a09e6eda..c7bfcf2cbb5f87b0154e3a1e743bc7d0059cd1c9:/Maintenance/makefile diff --git a/Maintenance/makefile b/Maintenance/makefile index 7bc8cc155..8daf9c149 100644 --- a/Maintenance/makefile +++ b/Maintenance/makefile @@ -6,12 +6,15 @@ # www.lufa-lib.org # -# Maintenance scripts not required by general LUFA users, used for development. +# Maintenance scripts not required by general LUFA users, used for project development purposes. + +# Path to the root of the LUFA tree LUFA_ROOT = ../ all: +# Update all Doxygen configuration files to the latest Doxygen version - force Markdown support to be disabled upgrade-doxygen: @echo Upgrading Doxygen.conf files... @for doxygen_conf in `find $(LUFA_ROOT) -name Doxygen.conf`; do \ @@ -20,8 +23,9 @@ upgrade-doxygen: mv -u $$doxygen_conf.new $$doxygen_conf; \ done; @echo Doxygen configuration update complete. - -check-release: + +# Check the working branch documentation, ensure no placeholder values +check-documentation-placeholders: @echo Checking for release suitability... @if ( grep "XXXXXX" $(LUFA_ROOT)/LUFA/DoxygenPages/*.txt > /dev/null ;); then \ echo " ERROR: Doxygen documentation has not been updated for release!"; \ @@ -32,3 +36,12 @@ check-release: exit 1; \ fi; @echo Done. + +# Validate the working branch - compile all documentation, demos/projects/examples and run build tests +validate-branch: + make -s -C $(LUFA_ROOT) doxygen + make -s -C $(LUFA_ROOT) all + make -s -C $(LUFA_ROOT)/BuildTests all + +# Validate the working branch for general release, check for placeholder documentation then build and test everything +validate-release: check-documentation-placeholders validate-branch