roboptim-commit Mailing List for RobOptim (Page 91)

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "build-aux".

The branch, master has been updated
       via  fb974647be8a62a5eae9ad63b3ee3ac02977945d (commit)
       via  70fd89d322e7e5df57e0ef4858b0c7ad44345b3e (commit)
      from  b223dcdab0f8e59ecca5f2c72f2d4443c1abafec (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit fb974647be8a62a5eae9ad63b3ee3ac02977945d
Author: Thomas Moulard <tho...@gm...>
Date:   Sat Oct 3 00:48:38 2009 +0200

    Discuss enhancements of Doxygen rules.
    
    	* doxygen.mk: Here.
    
    Signed-off-by: Thomas Moulard <tho...@gm...>

diff --git a/ChangeLog b/ChangeLog
index 4cc0afe..667ed80 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2009-10-03  Thomas Moulard  <tho...@gm...>
 
+	Discuss enhancements of Doxygen rules.
+	* doxygen.mk: Here.
+
+2009-10-03  Thomas Moulard  <tho...@gm...>
+
 	Handle Doxygen dependencies properly.
 	Warning: doxygen.mk is no more compatible with non-GNU make.
 	Please add -Wno-portability in when calling autoreconf to remove
diff --git a/doxygen.mk b/doxygen.mk
index f43bfdf..ad03096 100644
--- a/doxygen.mk
+++ b/doxygen.mk
@@ -25,13 +25,36 @@
 # ------ #
 # README #
 # ------ #
-
+#
 # This mk file contains Doxygen generation rules.
 #
 # To use this mk file, include init.mk and this file into
 # your Makefile.am. You must also provide a Doxyfile.extra
 # that may be used to override default Doxygen configuration
 # defined in build-aux/doxygen/Doxyfile.
+#
+# WARNING: This file uses GNU Make extension!
+
+# ---- #
+# TODO #
+# ---- #
+#
+# It is possible to avoid using GNU Make extension by avoiding
+# the use of patterns in Doxyfile and listing sources files instead.
+# For instance, the project could generate a ``doxygen.dep'' file
+# in each build directory of directories containing source files
+# (see SOURCES variable). I.e.:
+# doxygen.dep: Makefile
+#	echo "DOXYGEN_INPUT = \"$(DOXYGEN_INPUT) $(SOURCES)\"" > $@
+#
+# ...and then it might be possible to include all these file in the Makefile.am
+# including this file. The INPUT field of Doxyfile would be then generated
+# automatically and it would be trivial to handle dependencies.
+#
+# P.S.: this is a general idea and not a perfect implementation, one problem
+# is that doxygen.dep file will have to contain absolute paths and not relative as
+# it is usually the case in Automake.
+
 
 # Distributed files.
 EXTRA_DIST += 						\

commit 70fd89d322e7e5df57e0ef4858b0c7ad44345b3e
Author: Thomas Moulard <tho...@gm...>
Date:   Sat Oct 3 00:38:46 2009 +0200

    Handle Doxygen dependencies properly.
    
    	Warning: doxygen.mk is no more compatible with non-GNU make.
    	Please add -Wno-portability in when calling autoreconf to remove
    	warning and add a note specifying that GNU make is now required.
    
    	* doxygen.mk: Use doxygen-deps to deduce Doxygen
    	generated documentation dependencies.
    	* doxygen/doxygen-deps.sh: New.
    
    Signed-off-by: Thomas Moulard <tho...@gm...>

diff --git a/ChangeLog b/ChangeLog
index 50b659f..4cc0afe 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,14 @@
+2009-10-03  Thomas Moulard  <tho...@gm...>
+
+	Handle Doxygen dependencies properly.
+	Warning: doxygen.mk is no more compatible with non-GNU make.
+	Please add -Wno-portability in when calling autoreconf to remove
+	warning and add a note specifying that GNU make is now required.
+
+	* doxygen.mk: Use doxygen-deps to deduce Doxygen
+	generated documentation dependencies.
+	* doxygen/doxygen-deps.sh: New.
+
 2009-09-25  Thomas Moulard  <tho...@gm...>
 
 	Fix path in documentation upload script.
diff --git a/doxygen.mk b/doxygen.mk
index 4f661c0..f43bfdf 100644
--- a/doxygen.mk
+++ b/doxygen.mk
@@ -53,10 +53,12 @@ CLEANFILES +=				\
 	Doxyfile			\
 	config.log
 
+DOXYGEN_DEPS = $(shell \
+	$(top_srcdir)/build-aux/doxygen/doxygen-deps.sh Doxyfile)
+
 # Targets rebuilt unconditionally.
 .PHONY: doc				\
 	html				\
-	doxygen-html 			\
 	install-doxygen-html		\
 	uninstall-doxygen-html
 
@@ -64,7 +66,7 @@ CLEANFILES +=				\
 doc: html
 html-local: doxygen-html
 
-doxygen-html: Doxyfile
+doxygen-html: Doxyfile $(DOXYGEN_DEPS)
 	@if test -d doxygen-html ; then \
 	  rm -rf doxygen-html/; 	\
 	fi
diff --git a/doxygen/doxygen-deps.sh b/doxygen/doxygen-deps.sh
new file mode 100755
index 0000000..ebfbcb9
--- /dev/null
+++ b/doxygen/doxygen-deps.sh
@@ -0,0 +1,105 @@
+#! /bin/sh
+# Copyright (C) 2009 by Thomas Moulard, AIST, CNRS, INRIA.
+# This file is part of the roboptim.
+#
+# roboptim is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Additional permission under section 7 of the GNU General Public
+# License, version 3 ("GPLv3"):
+#
+# If you convey this file as part of a work that contains a
+# configuration script generated by Autoconf, you may do so under
+# terms of your choice.
+#
+# roboptim is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with roboptim.  If not, see <http://www.gnu.org/licenses/>.
+
+##########
+# README #
+##########
+
+# This shell script extracts dependencies of a Doxygen manual.
+# Its input is a Doxygen configuration file (i.e. a Doxyfile file)
+# and displays a list of input files used by Doxygen separated by
+# a whitespace character.
+# It is designed to produce a GNU make compatible dependency list.
+
+
+# die(MSG)
+# --------
+# Print an error message and exit.
+die ()
+{
+    echo >&2 "fatal: $1"
+    exit 2
+}
+
+# getDoxygenValue(KEY, FILE)
+# --------------------
+# Get a value from a Doxygen configuration file (usually
+# named Doxyfile). The argument is the key to retrieve
+# and the name of the configuration file.
+# The key value is returned by the function.
+getDoxygenValue ()
+{
+    sed ':a; /\\$/N; s/\\\n//; ta' "$2" | grep "^$1[ =]" | cut -d'=' -f2
+}
+
+
+# Check arguments.
+if ! test $# -eq 1; then
+    die "$0 expects exactly one argument"
+fi
+if ! test -f "$1"; then
+    die "``$1'' is not a regular file or does not exist"
+fi
+
+# Retrieve Doxygen configuration.
+INPUT=`getDoxygenValue INPUT "$1"`
+EXCLUDE=`getDoxygenValue EXCLUDE "$1"`
+FILE_PATTERNS=`getDoxygenValue FILE_PATTERNS "$1"`
+
+# Initialize variables.
+DEPENDENCIES=
+
+# Iterate on inputs.
+for input in $INPUT; do
+    # If input is a directory...
+    if test -d "$input"; then
+	# Build iteratively a shell command using ``find'' to
+	# search for the files matching the FILE_PATTERNS pattern.
+	CMD=
+	for ext in $FILE_PATTERNS; do
+	    CMD="$CMD -or -name '$ext'"
+	done
+
+	# Remove unwanted ``-or'' at the beginning of the command.
+	CMD=`echo "$CMD" | sed 's/-or//'`
+	# Build the final command.
+	CMD="find $input $CMD"
+	# Execute command and remove excluded files.
+	DEPS=`echo $CMD | sh | grep -v "$EXCLUDE" | xargs`
+	# Add results to list.
+	DEPENDENCIES="$DEPENDENCIES $DEPS"
+
+    # If input is a regular file...
+    elif test -f "$input"; then
+	# Add to the list.
+	DEPENDENCIES="$DEPENDENCIES $INPUT"
+
+    # Otherwise fail...
+    else
+	die "``$input'' is neither a directory nor a regular file."
+    fi
+done
+
+# Display result.
+echo "$DEPENDENCIES"

-----------------------------------------------------------------------

Summary of changes:
 ChangeLog               |   16 +++++++
 doxygen.mk              |   31 ++++++++++++-
 doxygen/doxygen-deps.sh |  105 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 149 insertions(+), 3 deletions(-)
 create mode 100755 doxygen/doxygen-deps.sh


hooks/post-receive
-- 
build-aux




2009	Jan	Feb	Mar	Apr	May	Jun (62)	Jul (62)	Aug (36)	Sep (24)	Oct (41)	Nov (182)	Dec (8)
2010	Jan (12)	Feb (13)	Mar (104)	Apr (95)	May (90)	Jun (90)	Jul (93)	Aug (97)	Sep (91)	Oct (93)	Nov (90)	Dec (95)
2011	Jan (96)	Feb (84)	Mar (94)	Apr (91)	May (93)	Jun (91)	Jul (93)	Aug (93)	Sep (107)	Oct (93)	Nov (58)	Dec
2012	Jan (8)	Feb (4)	Mar	Apr (3)	May	Jun	Jul	Aug	Sep	Oct (1)	Nov (6)	Dec (5)
2013	Jan (16)	Feb (22)	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec

roboptim-commit Mailing List for RobOptim (Page 91)

roboptim-commit — Commit mailing-list (high volume)