Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 318475 - dev-util/gtk-doc-am API documentation tools handling should be optional
Summary: dev-util/gtk-doc-am API documentation tools handling should be optional
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: [OLD] GNOME (show other bugs)
Hardware: All Linux
: High enhancement with 2 votes (vote)
Assignee: Gentoo Linux Gnome Desktop Team
URL:
Whiteboard:
Keywords:
: 331283 (view as bug list)
Depends on: 262491
Blocks:
  Show dependency tree
 
Reported: 2010-05-04 18:24 UTC by Martin Väth
Modified: 2011-03-07 11:49 UTC (History)
6 users (show)

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


Attachments
Proposed patch against gtk-doc-am-1.15.ebuild (gtk-doc-am-doc-flag.patch,1.42 KB, patch)
2010-08-01 16:48 UTC, LB
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Martin Väth 2010-05-04 18:24:58 UTC
With the current pango-1.26.2 and gtk+-2.18.9 stabilization,
the docbook-* stuff is pulled in on practically every user's machine
even with USE='-doc' which IMHO is not very nice.

This could be avoided if gtk-doc-am would receive a USE=doc flag
(and if pango, gtk+ [and maybe some other packages] "inherit" their
USE=doc as a gtk-doc-am USE-dependency):

With USE=doc the behavior of the gtk-doc-am.ebuild would be the current one,
but with USE=-doc the ebuild could skip all installation except for
installing (by copying) the file /usr/share/aclocal/gtk-doc.m4 and need
not depend on anything.

Of course, this means that pango, gtk+, etc. will only compile with USE=-doc,
but by the proper inheritance of the USE-dependency this should be no problem.

I just tried a corresponding patched gtk-doc-am.ebuild in my local overlay,
and pango-1.26.2 and gtk+-2.18.9 compiled smoothly without any problems
(with USE=-doc, of course), without needing any docbook-*
Comment 1 LB 2010-08-01 16:48:06 UTC
Created attachment 240955 [details, diff]
Proposed patch against gtk-doc-am-1.15.ebuild

This patch implements the behaviour suggested. I tested with -doc on my system and pango/gtk/glib are building without any problems.
Comment 2 Gilles Dartiguelongue (RETIRED) gentoo-dev 2010-08-02 16:56:36 UTC

*** This bug has been marked as a duplicate of bug 305507 ***
Comment 3 LB 2010-08-02 20:21:51 UTC
I don't see how this bug is a dupe of 305507. 305507 refers to missing dependencies for full build of this package, while this bug is a request for enhancement that would allow not to pull several dependencies on a system that doesn't need docs. 
Comment 4 Gilles Dartiguelongue (RETIRED) gentoo-dev 2010-08-03 08:21:44 UTC
Just to restate the goals of this ebuild:

goal #1: provide gtk-doc.m4 to allow eautoreconf of packages using gtk-doc in their configure.ac
goal #2: allow to relink gtk-doc documentation at src_install time to enable us to remove USE="doc" from 99% of our packages since it is most often not building correctly in various cases that we don't/can't test and both upstream of the affected package and upstream of gtk-doc package pay little attention to how to enhance this situation, let alone fix already reported problems.

Now if gtkdoc-rebase does not need any of the doc stuff without eautoreconf, I'm fine with the changes, otherwise, it's a no-no.
Comment 5 Martin Väth 2010-08-03 09:04:12 UTC
For somebody who does not want to install any documentation and therefore sets
globally USE=-doc, goal #2 is not needed: This is what USE flags are for.

Of course, this means that packages like gtk+ cannot only have
  DEPEND=">=dev-util/gtk-doc-am-1.11"
but actually need
  DEPEND=">=dev-util/gtk-doc-am-1.11[doc?]"
or in the hopefully rare (perhaps currently non-existing) cases where the
corresponding documentation is installed unconditionally even
  DEPEND=">=dev-util/gtk-doc-am-1.11[doc]"
is needed.

This way, all users should be happy:
For those who want the documentation (and thus need gtk-rebase)
for at least one corresponding package, portage will ensure that
gtk-doc-am[doc] is installed, i.e. for those users nothing will
change or break.
But those users with global USE=-doc who do not want any documenation
will not have to install docbook (and it is really not needed for them).
Comment 6 Gilles Dartiguelongue (RETIRED) gentoo-dev 2010-08-03 09:46:24 UTC
Ah right, that reminds me we wanted to make API documentation installation optional. Anyway, we are making improvements step by step, see bug #262491
Comment 7 Gilles Dartiguelongue (RETIRED) gentoo-dev 2010-08-03 09:47:21 UTC
fixing summary and attaching to tracker
Comment 8 Gilles Dartiguelongue (RETIRED) gentoo-dev 2010-08-05 07:58:33 UTC
*** Bug 331283 has been marked as a duplicate of this bug. ***
Comment 9 Joshua Kinard gentoo-dev 2010-08-22 07:57:11 UTC
Throwing my voice into this, too.  Since eautoreconf is one of the functions in the eclasses folder, and it depends on gtk-am-doc, this pretty much drags in documentation stuff on virtually every Gentoo system out there.  Some of us are quite selective on installed stuff, so this is a bit excessive.  I'm with the reporter that documentation stuff should be locked behind an optional USE check instead of being mandatory.

What's the status on fixing things up so this change can be made?
Comment 10 Gilles Dartiguelongue (RETIRED) gentoo-dev 2010-10-04 12:14:10 UTC
After verification, it occurs that this patch is wrong.
Skipping installation of the DTDs is possible but, for example, if libxslt is missing, configure will fail, same for pkgconfig.
Comment 11 LB 2010-10-04 19:20:23 UTC
The configure should only run if "+doc" is set. When I emerge using a patched ebuild with "-doc", configure doesn't run. I just tested building without libxslt present and it worked. 
Comment 12 Ed Wildgoose 2011-03-05 19:10:05 UTC
Little things like this are quite a pain for those of us running 10-100 virtual servers (and my embedded builds).  Any chance of bumping some interest in this bug?  What are the holdups to implementing (so that we can solve them)?
Comment 13 Gilles Dartiguelongue (RETIRED) gentoo-dev 2011-03-07 09:34:31 UTC
The holdups is manpower.
Comment 14 Ed Wildgoose 2011-03-07 10:26:59 UTC
That's a fair reply - is there some way I can help? I have some capacity to help with bug fixing?
Comment 15 Nirbheek Chauhan (RETIRED) gentoo-dev 2011-03-07 11:49:48 UTC
Gilles and I discussed this again, and decided that the proper way of fixing this involves getting rid of gtk-doc-am (and a lot of other stuff), so we can hack around things in gtk-doc-am till we can fix everything properly and get rid of the package.

With 1.17, the docbook dependencies are no longer required to install gtk-doc-am, this should be fixed now. Thanks for reporting!