From cf637f2510d5e69855d62a4c3306094abfcbb68c Mon Sep 17 00:00:00 2001 From: George Joseph Date: Thu, 7 May 2015 13:54:35 -0600 Subject: [PATCH] doc: Make progdocs play nice with git Moved contrib/asterisk-ng-doxygen to doc/asterisk-ng-doxygen.in Changed /Makefile to copy asterisk-ng-doxygen.in to asterisk-ng-doxygen then modify it with version instead of modifying asterisk-ng-doxygen directly. Updated clean targets as well. Updated /.gitignore and doc/.gitignore. Change-Id: I38712d3e334fa4baec19d30d05de8c6f28137622 --- .gitignore | 3 +++ Makefile | 18 +++++++++++------- doc/.gitignore | 4 +++- .../asterisk-ng-doxygen.in | 0 4 files changed, 17 insertions(+), 8 deletions(-) rename contrib/asterisk-ng-doxygen => doc/asterisk-ng-doxygen.in (100%) diff --git a/.gitignore b/.gitignore index 4b19213cc2..0281e107cf 100644 --- a/.gitignore +++ b/.gitignore @@ -31,3 +31,6 @@ menuselect-tree *.pyc *.gcno *.gcda +latex +doxygen.log + diff --git a/Makefile b/Makefile index 3252f76828..17a25514d4 100644 --- a/Makefile +++ b/Makefile @@ -429,6 +429,8 @@ _clean: rm -f doc/core-en_US.xml rm -f doc/full-en_US.xml rm -f doc/rest-api/*.wiki + rm -f doxygen.log + rm -rf latex rm -f rest-api-templates/*.pyc @$(MAKE) -C menuselect clean cp -f .cleancount .lastclean @@ -445,6 +447,7 @@ distclean: $(SUBDIRS_DIST_CLEAN) _clean rm -f include/asterisk/autoconfig.h rm -f include/asterisk/buildopts.h rm -rf doc/api + rm -f doc/asterisk-ng-doxygen rm -f build_tools/menuselect-deps datafiles: _all doc/core-en_US.xml @@ -763,7 +766,8 @@ webvmail: @echo " +-------------------------------------------+" progdocs: - # Note, Makefile conditionals must not be tabbed out. Wasted hours with that. +# Note, Makefile conditionals must not be tabbed out. Wasted hours with that. + @cp doc/asterisk-ng-doxygen.in doc/asterisk-ng-doxygen ifeq ($(DOXYGEN),:) @echo "Doxygen is not installed. Please install and re-run the configuration script." else @@ -771,20 +775,20 @@ ifeq ($(DOT),:) @echo "DOT is not installed. Doxygen will not produce any diagrams. Please install and re-run the configuration script." else # Enable DOT - @echo "HAVE_DOT = YES" >> contrib/asterisk-ng-doxygen + @echo "HAVE_DOT = YES" >> doc/asterisk-ng-doxygen endif # Set Doxygen PROJECT_NUMBER variable ifneq ($(ASTERISKVERSION),UNKNOWN__and_probably_unsupported) - @echo "PROJECT_NUMBER = $(ASTERISKVERSION)" >> contrib/asterisk-ng-doxygen + @echo "PROJECT_NUMBER = $(ASTERISKVERSION)" >> doc/asterisk-ng-doxygen else echo "Asterisk Version is unknown, not configuring Doxygen PROJECT_NUMBER." endif - # Validate Doxygen Configuration - @doxygen -u contrib/asterisk-ng-doxygen + # Validate and auto-update local copy + @doxygen -u doc/asterisk-ng-doxygen # Run Doxygen - @doxygen contrib/asterisk-ng-doxygen + @doxygen doc/asterisk-ng-doxygen # Remove configuration backup file - @rm -f contrib/asterisk-ng-doxygen.bak + @rm -f doc/asterisk-ng-doxygen.bak endif install-logrotate: diff --git a/doc/.gitignore b/doc/.gitignore index e098ec027f..3461c58c5e 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,2 +1,4 @@ core-en_US.xml -rest-api \ No newline at end of file +rest-api +api +asterisk-ng-doxygen diff --git a/contrib/asterisk-ng-doxygen b/doc/asterisk-ng-doxygen.in similarity index 100% rename from contrib/asterisk-ng-doxygen rename to doc/asterisk-ng-doxygen.in