Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 404965 - dev-libs/dbus-glib[doc] installs gtk-doc API documentation outside /usr/share/gtk-doc/html
Summary: dev-libs/dbus-glib[doc] installs gtk-doc API documentation outside /usr/share...
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: [OLD] Library (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Freedesktop bugs
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-02-20 06:03 UTC by Alexandre Rostovtsev (RETIRED)
Modified: 2012-10-10 10:39 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Alexandre Rostovtsev (RETIRED) gentoo-dev 2012-02-20 06:03:30 UTC
dev-libs/dbus-glib with USE=doc installs its gtk-doc API documentation in /usr/share/doc/${PF}/html/dbus-glib instead of the expected location, /usr/share/gtk-doc/html/dbus-glib. As a result, standard development tools for dealing with gtk-doc documentation, e.g. dev-util/devhelp, cannot find it or use it.

If the relevant parties want to stick to Gentoo tradition and keep the awful /usr/share/doc/${PF}/html location, then the ebuild at least needs to make /usr/share/gtk-doc/html/dbus-glib a symlink to /usr/share/doc/${PF}/html/dbus-glib.
Comment 1 Rafał Mużyło 2012-09-25 18:02:38 UTC
That incorrect path is one this (and '--with-html-dir' option should simply be dropped, otherwise docs would have to be regenerated to be installed and work), but there's more:

1. as of 0.100 upstream failed to include a few generated doc files in the tarball (they can be regenerated, but obviously that's not the point) - that shouldn't be hard to fix upstream
2. the ebuild can't install even those few doc files that are distributed; a simple fix:
ln -s "${S}/doc/reference/html" doc/reference/html

right after 'ECONF_SOURCE="${S}" econf "${myconf[@]}"'

...well, at least it works for -doc, I haven't tested what happens when docs rebuild is enabled.
Comment 2 Alexandre Rostovtsev (RETIRED) gentoo-dev 2012-10-10 10:39:11 UTC
Fixed in 0.100-r1.

By the way, an additional reason for using the standard install location is that it allows links between different packages' documentation pages, which are fairly common in the gnome ecosystem, and are automatically handled by gtk-doc as long as everything is installed in the expected directories under /usr/share/gtk-doc.

(In reply to comment #1)
The docs provided in the 0.100 tarball are incomplete and broken, so we have to regenerate them if we want to install them; see https://bugs.freedesktop.org/show_bug.cgi?id=55830

>*dbus-glib-0.100-r1 (10 Oct 2012)
>
>  10 Oct 2012; Alexandre Rostovtsev <tetromino@gentoo.org>
>  +dbus-glib-0.100-r1.ebuild, +files/dbus-glib-0.100-dbus-glib-sections.txt:
>  Fix broken API docs; prevents build failure with libxslt-1.1.27 (bug #436454,
>  thanks to Andrew Savchenko). Install API docs in /usr/share/gtk-doc to allow
>  links from other packages' documentation files, and for compatibility with
>  standard tools like dev-util/devhelp (bug #404965).