Re: [gentoo-dev] Changing doc use flag on gtk-doc packages to gtk-doc-rebuild or something else

[Mart Raudsepp <leio@gentoo.org>]

[-- Attachment #1: Type: text/plain, Size: 3076 bytes --]

On P, 2008-10-05 at 20:34 +0200, Thomas Sachau wrote:
> Rémi Cardona schrieb:
> > Thomas Sachau a écrit :
> >> Why not do both (rebuild and install) with the doc useflag and none of
> >> both, if it is not set? Imho
> >> the doc flag is for control of installation for (additional) docs, the
> >> way it is used for gtk-doc is
> >> surely confusing.
> >>
> > 
> > Building gtk-doc documentation pulls in a lot of deps. Installing it
> > requires only some disk-space. For a full Gnome system, I only have 96M
> > of docs.
> > 
> > As for rebuilding docs, one of the advantage is to correctly crosslink
> > docs for tools such as dev-util/devhelp.
> > 
> > If anyone is _that_ short on diskspace, we'll gladly take patches :)
> > 
> > Cheers
> > 
> > Rémi
> > 
> > 
> 
> Did i say something about disk space? I say, you are using the doc use flag in a way that is not
> expected.

The doc USE flag is typically used when it means additional
dependencies, noticeable build time increase or extra downloads. For all
the GNOME packages the former two apply for USE=doc because it requires
a hefty dependency list for doc generation and a long documentation
regeneration time.
The tradition is to always install documentation that is already
available. That is what we do. Those that want extra benefits of waiting
on the doc building to get better doc hyperlinking and such, can do so
with USE=doc, which is expected to take a longer time to build.

> The global use flag says, it installs additional documentation. But your doc use flag does
> not install anything additional, but instead rebuilds those docs. There is nothing wrong with
> rebuilding them on use=doc, but imho you should also only install those docs with use=doc.

Docs are installed always when they do not mean extra downloads, build
time or dependencies. They don't if they are kept in the form they are
in the tarballs already, so we already install them, just like many
other packages do (including all the dodoc's)

> The patch could be as simple as adding >use doc || rm -rf "${D}"usr/share/gtk-doc< at the end of
> src_install()-function in gnome2.eclass, that should be simple enough to apply without a patch. :)

Sorry, I'm not convinced there is anything to patch or change here.

> Btw: e.g. x11-libs/gtk+ has no doc use flag, does not rebuild those docs, but does also install
> those docs as reported in bug 239524.

It does have a doc USE flag, and it controls the same thing it does for
everything else gtk-doc - passing --disable-gtk-doc or --enable-gtk-doc
which acts like described above for regeneration.


Making USE=doc control both installation and regeneration is out of the
question. The benefits of rebuilding are not that big that everyone
would want to do that, especially with recent versions of gtk-doc, but
some do want it. Use INSTALL_MASK if you don't want developer API docs
is the current stance.


-- 
Mart Raudsepp
Gentoo Developer
Mail: leio@gentoo.org
Weblog: http://planet.gentoo.org/developers/leio

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 197 bytes --]