You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
54 lines
2.0 KiB
54 lines
2.0 KiB
#
|
|
# LUFA Library
|
|
# Copyright (C) Dean Camera, 2011.
|
|
#
|
|
# dean [at] fourwalledcubicle [dot] com
|
|
# www.lufa-lib.org
|
|
#
|
|
|
|
# Maintenance scripts not required by general LUFA users, used for project development purposes.
|
|
|
|
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 \
|
|
doxygen -u $$doxygen_conf; \
|
|
sed "s/MARKDOWN_SUPPORT *= *YES/MARKDOWN_SUPPORT = NO/1" $$doxygen_conf > $$doxygen_conf.new; \
|
|
mv -u $$doxygen_conf.new $$doxygen_conf; \
|
|
done;
|
|
@echo Doxygen configuration update complete.
|
|
|
|
# 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!"; \
|
|
exit 1; \
|
|
fi;
|
|
@if ( grep "000000" $(LUFA_ROOT)/LUFA/Version.h > /dev/null ;); then \
|
|
echo " ERROR: Version header has not been updated for release!"; \
|
|
exit 1; \
|
|
fi;
|
|
@echo Done.
|
|
|
|
# Test all generated documentation for any bad links
|
|
check-documentation-links:
|
|
@for html_file in `find $(LUFA_ROOT) -name *.html`; do \
|
|
echo Checking $$html_file...; \
|
|
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=-; \
|
|
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
|