headers
Petteri Räty | 5 Oct 15:02
Favicon

Changing doc use flag on gtk-doc packages to gtk-doc-rebuild or something else

Currently the doc use flag on gtk-doc using packages does not control
doc installation but instead whether to rebuild them so that they are
properly cross linked. I think we should be using a separate use flag
from doc for this purpose. Any comments?

15:40 <@Betelgeuse> EvaSDK: Just change the doc use flag to something
else and it won't confuse people
15:56 <@EvaSDK> Betelgeuse: it not like it's been like this forever...
15:56 <@EvaSDK> send a mail to -dev if you want to discuss it

Regards,
Petteri
Permalink | Reply |
headers
Thomas Sachau | 5 Oct 15:29
Favicon

Re: Changing doc use flag on gtk-doc packages to gtk-doc-rebuild or something else

Petteri Räty schrieb:
> Currently the doc use flag on gtk-doc using packages does not control
> doc installation but instead whether to rebuild them so that they are
> properly cross linked. I think we should be using a separate use flag
> from doc for this purpose. Any comments?
> 
> 15:40 <@Betelgeuse> EvaSDK: Just change the doc use flag to something
> else and it won't confuse people
> 15:56 <@EvaSDK> Betelgeuse: it not like it's been like this forever...
> 15:56 <@EvaSDK> send a mail to -dev if you want to discuss it
> 
> Regards,
> Petteri
> 

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.

--

-- 
Thomas Sachau

Gentoo Linux Developer
Permalink | Reply |
headers
Rémi Cardona | 5 Oct 18:27
Favicon

Re: Changing doc use flag on gtk-doc packages to gtk-doc-rebuild or something else

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
Permalink | Reply |
headers
Thomas Sachau | 5 Oct 20:34
Favicon

Re: Changing doc use flag on gtk-doc packages to gtk-doc-rebuild or something else

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 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.

The patch could be as simple as adding >use doc || rm -rf "${D}"usr/share/gtk-doc< at the end of
(Continue reading)

Permalink | Reply |
headers
Gilles Dartiguelongue | 5 Oct 21:54
Favicon

Re: Changing doc use flag on gtk-doc packages to gtk-doc-rebuild or something else

Le dimanche 05 octobre 2008 à 20:34 +0200, Thomas Sachau a écrit :
> Did i say something about disk space? I say, you are using the doc use flag in a way that is not
> expected. 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.
> 
> 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. :)

I've not dig that information but it seems to me this is the way it is
because gtk-doc configure switch itself acts like this.

Now if ones digs the archive of this mailing list, I think there was
some talk about renaming the flag for compilation vs. installation only
in order to be more consistent with global use flag meaning but I can't
remember the outcome.

Besides if one really doesn't want to install _any_ gtk-doc there is
still the INSTALL_MASK option (I know it's for l33t users reading mans,
but...).
--

-- 
Gilles Dartiguelongue <eva <at> gentoo.org>
Gentoo
Permalink | Reply |
headers
Mart Raudsepp | 6 Oct 01:24
Favicon

Re: Changing doc use flag on gtk-doc packages to gtk-doc-rebuild or something else

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
(Continue reading)

Permalink | Reply |
headers
Petteri Räty | 6 Oct 02:46
Favicon

Re: Changing doc use flag on gtk-doc packages to gtk-doc-rebuild or something else

Mart Raudsepp kirjoitti:
> 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
(Continue reading)

Permalink | Reply |
headers
Mart Raudsepp | 7 Oct 21:56
Favicon

Re: Changing doc use flag on gtk-doc packages to gtk-doc-rebuild or something else

On E, 2008-10-06 at 03:46 +0300, Petteri Räty wrote:
> With USE="doc" the GNOME packages behave like what you expect but it's
> the USE="-doc" case that's in question here. With USE="-doc" you don't
> get any use flags installed normally and if it's in the tarball and is
> always installed then there is no doc in IUSE either. Global use flags
> should behave about the same for both on and off cases.

So you propose we would always install the documentation, but have a new
global USE flag (remember, we are talking about over a hundred of
packages here - everything that inherits gnome2.eclass) with a yet to be
determined name to control the re-generation?

However, with the advancements of the gtk-doc system, there _might_ not
be any more benefits in rebuilding the documentation, so I've had the
intention to check that out and perhaps propose removing the doc USE
flag completely and never regenerate it if it's true that it has no
point. But checking this has been quite a low priority, and given that
we need to get GNOME-2.24 out there for the users, it remains so during
this month, at least for me.

I would propose that we (the GNOME team) investigates the benefits (or
lack thereof these days) of the regeneration in the first part of
November, and if we don't, you get to remind us and we take care of it
as the hurry with a new major GNOME version, that users are awaiting
(including squashing all bugs needed before stabilization), will be over
then.

Taking the renaming of the USE flag approach as a start would also mean
touching many GNOME packages (build-depends on gtk-doc if eautoreconf is
involved), and I'd rather not risk that at the moment. It would also
(Continue reading)

Permalink | Reply |

Gmane