| 1 |
On P, 2008-10-05 at 20:34 +0200, Thomas Sachau wrote: |
| 2 |
> Rémi Cardona schrieb: |
| 3 |
> > Thomas Sachau a écrit : |
| 4 |
> >> Why not do both (rebuild and install) with the doc useflag and none of |
| 5 |
> >> both, if it is not set? Imho |
| 6 |
> >> the doc flag is for control of installation for (additional) docs, the |
| 7 |
> >> way it is used for gtk-doc is |
| 8 |
> >> surely confusing. |
| 9 |
> >> |
| 10 |
> > |
| 11 |
> > Building gtk-doc documentation pulls in a lot of deps. Installing it |
| 12 |
> > requires only some disk-space. For a full Gnome system, I only have 96M |
| 13 |
> > of docs. |
| 14 |
> > |
| 15 |
> > As for rebuilding docs, one of the advantage is to correctly crosslink |
| 16 |
> > docs for tools such as dev-util/devhelp. |
| 17 |
> > |
| 18 |
> > If anyone is _that_ short on diskspace, we'll gladly take patches :) |
| 19 |
> > |
| 20 |
> > Cheers |
| 21 |
> > |
| 22 |
> > Rémi |
| 23 |
> > |
| 24 |
> > |
| 25 |
> |
| 26 |
> Did i say something about disk space? I say, you are using the doc use flag in a way that is not |
| 27 |
> expected. |
| 28 |
|
| 29 |
The doc USE flag is typically used when it means additional |
| 30 |
dependencies, noticeable build time increase or extra downloads. For all |
| 31 |
the GNOME packages the former two apply for USE=doc because it requires |
| 32 |
a hefty dependency list for doc generation and a long documentation |
| 33 |
regeneration time. |
| 34 |
The tradition is to always install documentation that is already |
| 35 |
available. That is what we do. Those that want extra benefits of waiting |
| 36 |
on the doc building to get better doc hyperlinking and such, can do so |
| 37 |
with USE=doc, which is expected to take a longer time to build. |
| 38 |
|
| 39 |
> The global use flag says, it installs additional documentation. But your doc use flag does |
| 40 |
> not install anything additional, but instead rebuilds those docs. There is nothing wrong with |
| 41 |
> rebuilding them on use=doc, but imho you should also only install those docs with use=doc. |
| 42 |
|
| 43 |
Docs are installed always when they do not mean extra downloads, build |
| 44 |
time or dependencies. They don't if they are kept in the form they are |
| 45 |
in the tarballs already, so we already install them, just like many |
| 46 |
other packages do (including all the dodoc's) |
| 47 |
|
| 48 |
> The patch could be as simple as adding >use doc || rm -rf "${D}"usr/share/gtk-doc< at the end of |
| 49 |
> src_install()-function in gnome2.eclass, that should be simple enough to apply without a patch. :) |
| 50 |
|
| 51 |
Sorry, I'm not convinced there is anything to patch or change here. |
| 52 |
|
| 53 |
> Btw: e.g. x11-libs/gtk+ has no doc use flag, does not rebuild those docs, but does also install |
| 54 |
> those docs as reported in bug 239524. |
| 55 |
|
| 56 |
It does have a doc USE flag, and it controls the same thing it does for |
| 57 |
everything else gtk-doc - passing --disable-gtk-doc or --enable-gtk-doc |
| 58 |
which acts like described above for regeneration. |
| 59 |
|
| 60 |
|
| 61 |
Making USE=doc control both installation and regeneration is out of the |
| 62 |
question. The benefits of rebuilding are not that big that everyone |
| 63 |
would want to do that, especially with recent versions of gtk-doc, but |
| 64 |
some do want it. Use INSTALL_MASK if you don't want developer API docs |
| 65 |
is the current stance. |
| 66 |
|
| 67 |
|
| 68 |
-- |
| 69 |
Mart Raudsepp |
| 70 |
Gentoo Developer |
| 71 |
Mail: leio@g.o |
| 72 |
Weblog: http://planet.gentoo.org/developers/leio |
Archives