GNOME Bugzilla – Bug 535074
Separate build/install gtk-doc stuff
Last modified: 2009-11-14 21:25:43 UTC
This patch separates the option for building, and just installing gtk-doc documentation. It adds a new --enable-gtk-doc-build flag that acts as the previous --enable-gtk-doc. The new --enable-gtk-doc flag now installs the gtk-doc documentation if the files are present (from the tarball for example), otherwise does nothing. The --enable-gtk-doc-build flag activates --enable-gtk-doc, so only one is required. Outside of "common", packages would be affected since ENABLE_PLUGIN_DOCS is deprecated, and now there is BUILD_PLUGIN_DOCS which is only used in gtk-doc-plugins.mak. I'm attaching also the changes required in gstreamer core, but all the other packages should be updated as well.
Created attachment 111601 [details] [review] Changes in common
Created attachment 111602 [details] [review] Changes in core.
I forgot to mention the issue here. The problem is that in the dist, the docs are already built, but ENABLE_PLUGIN_DOCS depends on ENABLE_GTK_DOC, which is disabled. So even if the plug-in documents are there (already built) they don't get installed.
Can somebody review this? It makes it more difficult to distribute proper documentation.
As Stefan requested I'm attaching the offending html: /usr/share/gtk-doc/html/gstreamer-0.10/api-index.html There's no "left.png" in that directory. <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"> <td><a accesskey="p" href="gstreamer-hierarchy.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">GStreamer 0.10 Core Reference Manual</th> <td><a accesskey="n" href="ix02.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> </tr></table> <div class="index">
The initial fix was here: http://webcvs.freedesktop.org/gstreamer/common/gtk-doc.mak?hideattic=0&r1=1.21&r2=1.22&pathrev=HEAD&sortby=rev But then the 'plugins' directory was missing, so: http://webcvs.freedesktop.org/gstreamer/gstreamer/docs/Makefile.am?hideattic=0&r1=1.43&r2=1.44&pathrev=HEAD&sortby=rev It's not a proper fix, that's what this bug report is for.
Created attachment 117984 [details] new makefile
Created attachment 117985 [details] new makefile for plgins Felipe, can you put these two into common. It works fine for me. Thats what I did: * changed the files in common to these new one * autogengen.sh * make dist * unpack the dist tarball somehwere else * ./configure --disable-gtk-doc * make && sudo make install The docs installed to /usr/local/share/gtk-doc/html/gstreamer-0.10/ have css and png files installed.
Stefan: actually now I'm understanding my own code again :) Your patch doesn't affect the issue, but would be good to have anyway. So please leave this bug report open. I think this is a low priority issue, this commit [1] fixed the missing plugins directory issue, but creates another one. If somebody who doesn't wish the gtk-doc to be built tries to do compile from CVS will have issues because PLUGIN_DOCS_DIRS = plugins if GTK_DOC is disabled. So I'm not sure this is really an issue. Will have to re-check. [1] http://webcvs.freedesktop.org/gstreamer/gstreamer/docs/Makefile.am?hideattic=0&r1=1.43&r2=1.44&pathrev=HEAD&sortby=rev
Ok, I'll commit my makefiles later. I think the latter isn't an issues, as the gtk-doc.mak has "if ENABLE_GTK_DOC" around the relevant parts. Imho this could be closed.
Any news on this?
Stefan? (also marking the first two patches as obsolete as Stefan's changes fix this too if I understand this correctly)
(In reply to comment #3) > I forgot to mention the issue here. > > The problem is that in the dist, the docs are already built, but > ENABLE_PLUGIN_DOCS depends on ENABLE_GTK_DOC, which is disabled. So even if the > plug-in documents are there (already built) they don't get installed. Disregard this comment, it was fixed by: http://cgit.freedesktop.org/gstreamer/gstreamer/commit/?id=3078614232e228db9274044ce8ba5c1996f45156 I don't know what I was talking about.
(In reply to comment #10) > Ok, I'll commit my makefiles later. I think the latter isn't an issues, as the > gtk-doc.mak has "if ENABLE_GTK_DOC" around the relevant parts. Imho this could > be closed. Yes, the issue is actually fixed.
These patches would still help in the case somebody doesn't want to install the gtk-doc documentation. But I think another patch for --disable-doc would probably be much better for that... I give that a try. Sorry for the delay in updating this. Closing this.