After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 460753 - enable vpath build in gtkdoc-mkhtml
enable vpath build in gtkdoc-mkhtml
Status: RESOLVED FIXED
Product: gtk-doc
Classification: Platform
Component: general
1.8
Other Linux
: Normal normal
: 1.11
Assigned To: gtk-doc maintainers
gtk-doc maintainers
Depends on:
Blocks: 127049
 
 
Reported: 2007-07-26 21:24 UTC by Yeti
Modified: 2008-07-20 13:50 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
proposed patch (1.12 KB, patch)
2007-07-26 21:25 UTC, Yeti
none Details | Review
proposed patch (1.80 KB, patch)
2007-07-26 21:57 UTC, Yeti
committed Details | Review

Description Yeti 2007-07-26 21:24:23 UTC
One of the main obstacles in VPATH builds is the impossibility to pass

--path $(abs_srcdir)

to xsltproc in gtkdoc-mkhtml, this forces one to physically copy content files to builddir with all the complications it brings.
Comment 1 Yeti 2007-07-26 21:25:23 UTC
Created attachment 92496 [details] [review]
proposed patch

Accept additional arguments in gtkdoc-mkhtml and pass them to the backend.
Comment 2 Yeti 2007-07-26 21:57:49 UTC
Created attachment 92500 [details] [review]
proposed patch

A better patch, also adds option --path to gtkdoc-mkhtml.  This is translated to --path for xsltproc and to --directory for openjade (untested, I don't use openjade).

With this path it should be safe to add --path="$(srcdir)" to mkhtml invocation in gtk-doc.make unconditionally.
Comment 3 Stefan Sauer (gstreamer, gtkdoc dev) 2007-11-11 11:47:30 UTC
Sorry for having this ignored for so long. Can you briefly explain the issue to me and how I can reproduce it. Do I understand correctly that the goal is to get rid of:
cd $(srcdir) && cp $(HTML_IMAGES) html
in html-build make target?
Comment 4 Yeti 2007-11-11 16:14:49 UTC
The goal is to be able to have foo-docs.xml and content files in $(srcdir) and the generated xml files in $(builddir).
Comment 5 Stefan Sauer (gstreamer, gtkdoc dev) 2008-06-28 13:57:19 UTC
Oh yeah. Now I realized the same thing. It will also help resolving entities. In xml mode gtk-doc copies. Hopefully the app does not need to apss extra --path options.

2008-06-28  Stefan Kost  <ensonic@users.sf.net>

	patch by: David Nečas <yeti@physics.muni.cz>

	* examples/Makefile.am:
	* gtk-doc.make:
	* gtk-doc.notmpl.make:
	* gtkdoc-mkhtml.in:
	* tests/gtk-doc.make:
	* tests/gtk-doc.notmpl.make:
	  Add searchpath to gtkdoc.mkhtml. Fixes #460753
Comment 6 Mart Raudsepp 2008-07-20 13:50:07 UTC
(In reply to comment #2)
> Created an attachment (id=92500) [edit]
> proposed patch
> 
> A better patch, also adds option --path to gtkdoc-mkhtml.  This is translated
> to --path for xsltproc and to --directory for openjade (untested, I don't use
> openjade).
> 
> With this path it should be safe to add --path="$(srcdir)" to mkhtml invocation
> in gtk-doc.make unconditionally.

No, it isn't safe. Tarballs prepared with gtk-doc including this will fail documentation rebuild (--enable-gtk-doc) with a 1.10 or earlier gtk-doc installed on the system. I've filed Bug 543855 for that