Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 174573 - Improper use of USE-flags
Summary: Improper use of USE-flags
Status: RESOLVED WONTFIX
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Gentoo Quality Assurance Team
URL: http://devmanual.gentoo.org/general-c...
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-04-14 11:08 UTC by Lasse Bigum
Modified: 2007-05-09 17:30 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 Lasse Bigum 2007-04-14 11:08:39 UTC
The documentation found at the URL uses the $my_conf = ... stuff, which I think is deprecated. The more correct use would be to use econf $(use_enable gstreamer) etc.

This can confuse people who are searching for documentation on how to make their own ebuilds.

Reproducible: Always
Comment 1 Xavier Neys (RETIRED) gentoo-dev 2007-04-14 11:34:04 UTC
Please do read the descriptions when filing bugs.
See http://bugs.gentoo.org/enter_bug.cgi

Thanks.
Comment 2 Torsten Veller (RETIRED) gentoo-dev 2007-04-14 12:03:56 UTC
(In reply to comment #0)
> The documentation found at the URL uses the $my_conf = ... stuff, 
> which I think is deprecated.

No. Why do think it is?

> The more correct use would be to use econf $(use_enable
> gstreamer) etc.

You mean the example in "Conflicting USE Flags"?
Present a patch using use_* functions. The source is <http://devmanual.gentoo.org/general-concepts/use-flags/text.xml>


Debatable in this example is the usage of gnutls (especially if ssl is not set).
Comment 3 Lasse Bigum 2007-04-14 12:25:01 UTC
(In reply to comment #1)
> Please do read the descriptions when filing bugs.
> See http://bugs.gentoo.org/enter_bug.cgi

I did, but apparently I misread where I was supposed to direct the bug to.


(In reply to comment #2)
> (In reply to comment #0)
> > The documentation found at the URL uses the $my_conf = ... stuff, 
> > which I think is deprecated.
> 
> No. Why do think it is?

Okay, deprecated is not correct, but is it not better (for most purposes) to use the $(use_enable) variant?

> > The more correct use would be to use econf $(use_enable
> > gstreamer) etc.
> 
> You mean the example in "Conflicting USE Flags"?
> Present a patch using use_* functions. The source is
> <http://devmanual.gentoo.org/general-concepts/use-flags/text.xml>

Well, in this place (http://devmanual.gentoo.org/quickstart/index.html) they use the $(use_enable) variant, and it seems much easier to comprehend, even though I have to admit, I can't se how to do the "Conflicting USE Flags" example without using the "if ..elif ... fi" structure.

Perhaps just mentioning the $(use_enable) on that page would suffice?
Comment 4 Torsten Veller (RETIRED) gentoo-dev 2007-05-09 14:09:44 UTC
(In reply to comment #3)
> (In reply to comment #1)
> > Please do read the descriptions when filing bugs.
> > See http://bugs.gentoo.org/enter_bug.cgi
> 
> I did, but apparently I misread where I was supposed to direct the bug to.

It should be: Product "Doc Other", Component "Devmanual"

> (In reply to comment #2)
> > (In reply to comment #0)
> > > The documentation found at the URL uses the $my_conf = ... stuff, 
> > > which I think is deprecated.
> > 
> > No. Why do think it is?
> 
> Okay, deprecated is not correct, but is it not better (for most purposes) to
> use the $(use_enable) variant?

It is often shorter and easier to read.

> > > The more correct use would be to use econf $(use_enable
> > > gstreamer) etc.
> > 
> > You mean the example in "Conflicting USE Flags"?
> > Present a patch using use_* functions. The source is
> > <http://devmanual.gentoo.org/general-concepts/use-flags/text.xml>
> 
> Well, in this place (http://devmanual.gentoo.org/quickstart/index.html) they
> use the $(use_enable) variant, and it seems much easier to comprehend, even
> though I have to admit, I can't se how to do the "Conflicting USE Flags"
> example without using the "if ..elif ... fi" structure.
> 
> Perhaps just mentioning the $(use_enable) on that page would suffice?

I hope readers of the devmanual will learn about use_with and use_enable anyway. 
ebuild-writing/functions/src_compile/configuring says: "The use_enable and use_with utility functions should, where appropriate, be used[...]" 

Thanks for your report but i think closing it as "won't fix" is okay.
Comment 5 Lasse Bigum 2007-05-09 17:30:25 UTC
I have no problems with that, thanks for the feedback.