dmx: Construct paths in doxygen.conf to fix VPATH builds

Submitted by Dan Nicholson on Feb. 21, 2011, 1:59 a.m.

Details

Message ID 1298224790-784-1-git-send-email-dbn.lists@gmail.com
State Deferred, archived
Headers show

Not browsing as part of any series.

Commit Message

Dan Nicholson Feb. 21, 2011, 1:59 a.m.
The paths in doxygen.conf assumed that srcdir=builddir and broke
otherwise. Use autoconf to fill in the paths to the srcdir so that the
files can be found when users have a separate build directory (as with
distcheck).

Signed-off-by: Dan Nicholson <dbn.lists@gmail.com>
---
 I actually tested this now and contains a fix where the Makefile was
 referencing $(srcdir)/doxygen.conf, but it's now being created in the
 build directory.

 I also have rename detection on here to make the reviewing easier, so
 you'll need git am or apply to do the right thing.

 configure.ac                                 |    1 +
 hw/dmx/doc/.gitignore                        |    1 +
 hw/dmx/doc/Makefile.am                       |    2 +-
 hw/dmx/doc/{doxygen.conf => doxygen.conf.in} |   18 +++++++++---------
 4 files changed, 12 insertions(+), 10 deletions(-)
 rename hw/dmx/doc/{doxygen.conf => doxygen.conf.in} (98%)

Patch hide | download patch | download mbox

diff --git a/configure.ac b/configure.ac
index e1adeb5..f09cafc 100644
--- a/configure.ac
+++ b/configure.ac
@@ -2248,6 +2248,7 @@  hw/xfree86/utils/gtf/Makefile
 hw/dmx/config/Makefile
 hw/dmx/config/man/Makefile
 hw/dmx/doc/Makefile
+hw/dmx/doc/doxygen.conf
 hw/dmx/examples/Makefile
 hw/dmx/input/Makefile
 hw/dmx/glxProxy/Makefile
diff --git a/hw/dmx/doc/.gitignore b/hw/dmx/doc/.gitignore
index 6bdd862..92c1150 100644
--- a/hw/dmx/doc/.gitignore
+++ b/hw/dmx/doc/.gitignore
@@ -8,3 +8,4 @@  scaled.html
 scaled.pdf
 scaled.ps
 scaled.txt
+doxygen.conf
diff --git a/hw/dmx/doc/Makefile.am b/hw/dmx/doc/Makefile.am
index 4bbc8bf..838b6f2 100644
--- a/hw/dmx/doc/Makefile.am
+++ b/hw/dmx/doc/Makefile.am
@@ -34,7 +34,7 @@  all-local: html/annotated.html
 dist-local: html/annotated.html
 
 html/annotated.html: $(DOXYGEN_SRC)
-	$(DOXYGEN) $(srcdir)/doxygen.conf
+	$(DOXYGEN) doxygen.conf
 
 maintainer-clean-local:
 	rm -rf html/
diff --git a/hw/dmx/doc/doxygen.conf b/hw/dmx/doc/doxygen.conf.in
similarity index 98%
rename from hw/dmx/doc/doxygen.conf
rename to hw/dmx/doc/doxygen.conf.in
index f7a541f..f886a43 100644
--- a/hw/dmx/doc/doxygen.conf
+++ b/hw/dmx/doc/doxygen.conf.in
@@ -344,9 +344,9 @@  WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = .. \
-                         ../input \
-                         ../config
+INPUT                  = @srcdir@/.. \
+                         @srcdir@/../input \
+                         @srcdir@/../config
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -367,9 +367,9 @@  RECURSIVE              = NO
 # excluded from the INPUT source files. This way you can easily exclude a 
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = ../config/parser.c \
-                         ../config/parser.h \
-                         ../config/scanner.c
+EXCLUDE                = @srcdir@/../config/parser.c \
+                         @srcdir@/../config/parser.h \
+                         @srcdir@/../config/scanner.c
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories 
 # that are symbolic links (a Unix filesystem feature) are excluded from the input.
@@ -510,20 +510,20 @@  HTML_FILE_EXTENSION    = .html
 # each generated HTML page. If it is left blank doxygen will generate a 
 # standard header.
 
-HTML_HEADER            = doxygen.head
+HTML_HEADER            = @srcdir@/doxygen.head
 
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
 # each generated HTML page. If it is left blank doxygen will generate a 
 # standard footer.
 
-HTML_FOOTER            = doxygen.foot
+HTML_FOOTER            = @srcdir@/doxygen.foot
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
 # style sheet that is used by each HTML page. It can be used to 
 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
 # will generate a default style sheet
 
-HTML_STYLESHEET        = doxygen.css
+HTML_STYLESHEET        = @srcdir@/doxygen.css
 
 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
 # files or namespaces will be aligned in HTML using tables. If set to 

Comments

Dan Nicholson <dbn.lists@gmail.com> (20/02/2011):
> The paths in doxygen.conf assumed that srcdir=builddir and broke
> otherwise. Use autoconf to fill in the paths to the srcdir so that the
> files can be found when users have a separate build directory (as with
> distcheck).
> 
> Signed-off-by: Dan Nicholson <dbn.lists@gmail.com>

Tested-by: Cyril Brulebois <kibi@debian.org>

both in-tree and out-of-tree. Thanks.

KiBi.
On Sun, 2011-02-20 at 09:59 -0800, Dan Nicholson wrote:

> The paths in doxygen.conf assumed that srcdir=builddir and broke
> otherwise. Use autoconf to fill in the paths to the srcdir so that the
> files can be found when users have a separate build directory (as with
> distcheck).
> 
> Signed-off-by: Dan Nicholson <dbn.lists@gmail.com>
> ---
>  I actually tested this now and contains a fix where the Makefile was
>  referencing $(srcdir)/doxygen.conf, but it's now being created in the
>  build directory.
> 
>  I also have rename detection on here to make the reviewing easier, so
>  you'll need git am or apply to do the right thing.
> 


Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
Hi Dan,

Dan Nicholson <dbn.lists@gmail.com> (20/02/2011):
> The paths in doxygen.conf assumed that srcdir=builddir and broke
> otherwise. Use autoconf to fill in the paths to the srcdir so that
> the files can be found when users have a separate build directory
> (as with distcheck).
> 
> Signed-off-by: Dan Nicholson <dbn.lists@gmail.com>

since RC3 is happening RSN, it'd probably be a good idea to send that
patch to Keith?

KiBi.
On Fri, 25 Feb 2011 05:04:47 +0100, Cyril Brulebois <kibi@debian.org> wrote:

> since RC3 is happening RSN, it'd probably be a good idea to send that
> patch to Keith?

I can merge various build fixes before the final release as needed. I
want to get the server out for testing right away.