Bug 4906 - Ensure all used DISTRO_FEATURES are documented
Summary: Ensure all used DISTRO_FEATURES are documented
Status: RESOLVED FIXED
Alias: None
Product: Reference
Classification: Documentation
Component: handbook (show other bugs)
Version: unspecified
Hardware: All Multiple
: Undecided normal
Target Milestone: ---
Assignee: Scott Rifenbark
QA Contact:
URL: http://git.yoctoproject.org/cgit/cgit...
Whiteboard: 25 July 2013: RESOLVED
Depends on:
Blocks:
 
Reported: 2013-07-25 07:06 UTC by Laszlo Papp
Modified: 2013-07-25 12:25 UTC (History)
4 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Laszlo Papp 2013-07-25 07:06:25 UTC
I cannot find that poky distribution feature mentioned in the document, but I see it all around in projects:

https://www.yoctoproject.org/docs/current/poky-ref-manual/poky-ref-manual.html
Comment 1 Ross Burton 2013-07-25 07:58:31 UTC
The set of DISTRO_FEATURES in use and the set in the documentation doesn't exactly match.  At least one example is missing:

opengl: Whether the distribution should support OpenGL.

There are likely to be a few more, I'll do some greppage shortly.
Comment 2 Scott Rifenbark 2013-07-25 08:28:31 UTC
I have added this feature to the list of features the user can add through the DISTRO_FEATURES variable.  You can see the change at http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#ref-features-distro.

Scott
Comment 3 Laszlo Papp 2013-07-25 08:30:09 UTC
Hmm, interesting. I do not see opengl mentioned in there.
Comment 4 Ross Burton 2013-07-25 08:32:28 UTC
In between nfs and pci:

"opengl: Include the Open Graphics Library, which is a cross-language, multi-platform application programming interface used for rendering two and three-dimensional graphics."

You may have a stale cache if you can't see it.
Comment 5 Laszlo Papp 2013-07-25 08:35:02 UTC
I did use F5 so it probably required some time to sync up.

I see now, but I still do not understand the comment though. What does it mean "including". Also, what library exactly, et cetera?

Is that also good for ES, or that is a separate variable? Which opengl version? Or it is global? I think it would need a bit more clarification than just a short line.
Comment 6 Ross Burton 2013-07-25 08:43:30 UTC
DISTRO_FEATURES are high level, so "opengl" means "some form of OpenGL".  The library/libraries/versions used depends on the machine.

There is a known ambiguity about the meaning of the feature, currently it means "any form of GL".  Yes, there is work to be done to express the finer details of machines where both GL and GLES are available but GL is preferred over GLES (eg Pine View) or GLES over GL (eg Cedar View).  However, this isn't relevant here, the DISTRO_FEATURE is "OpenGL" without specifying a version or library.
Comment 7 Laszlo Papp 2013-07-25 08:48:28 UTC
I believe it is relevant to know the details about something that you are supposed to use. Please extend the documentation as much as possible.

Yes, we would know that there is an "opengl" feature, but would not be entirely sure what it means with the documentation currently available.

This is what the review is for, to catch such issues, right? :)
Comment 8 Ross Burton 2013-07-25 08:56:29 UTC
Are you suggesting a table of every machine (according to the layer index, that's 150-200) and every available GL implementation available?  That's going to be ... rather large.  And changing all the time.

The DISTRO_FEATURE just means "OpenGL support".  What that means at a concrete library/version level is up to the machine definition, as that is where the virtual/opengl etc providers are defined.
Comment 9 Laszlo Papp 2013-07-25 09:03:31 UTC
No, I mean clear documentation which can be a reference to virtual/opengl as well for further details. That reference is not present at the moment.
Comment 10 Scott Rifenbark 2013-07-25 09:10:40 UTC
Help me understand this a bit more... Are you looking for a linked reference to some other area on the Web?  If so, can someone point me to where the best reference for virtual/opengl would be?
Comment 11 Laszlo Papp 2013-07-25 09:34:20 UTC
I am fine with raw text reference if you cannot find an online url, but something has to be there to know where to read about details.
Comment 12 Scott Rifenbark 2013-07-25 12:17:18 UTC
I am marking this particular bug RESOLVED.  I will plan on creating a separate section that provides some details on GL details.  This new section transcends this bug as it is against mentioning opengl as a supported distro feature.  Including it in the list and providing a description that conforms to similar feature descriptions is good enough here.

Scott
Comment 13 Laszlo Papp 2013-07-25 12:22:01 UTC
Should I reopen this one or create a new one with the same issue?

Again, I do not really understand without further details what this feature is for. Seriously, go to #opengl, and ask around if you do not trust me.
Comment 14 Laszlo Papp 2013-07-25 12:23:43 UTC
Also, past mistakes are not excuse for repeating them.

Anyway, you did not make me a fully happy user if that matters... ;-)
Comment 15 Laszlo Papp 2013-07-25 12:25:17 UTC
bug 4913 submitted.