| Summary: | *_FEATURES variables documentation is inadequate | ||
|---|---|---|---|
| Product: | [Documentation] Reference | Reporter: | Darren Hart <dvhart> |
| Component: | handbook | Assignee: | Scott Rifenbark <srifenbark> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | Medium | CC: | jessica.zhang, poky.doc.watcher, poky.watcher |
| Version: | unspecified | ||
| Target Milestone: | 1.4 | ||
| Hardware: | x86 | ||
| OS: | Multiple | ||
| URL: | http://git.yoctoproject.org/cgit.cgi/yocto-docs/commit/?id=261cc16ad900f7f5254fa97dab82beab94f717d3 | ||
| Whiteboard: | 11 Feb 2013 - resolved/fixed | ||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | --- | |
|
Description
Darren Hart
2012-10-16 22:50:01 UTC
Darren, Agreed - I need as much information on how these variables actually affect things in order to improve their descriptions. If you can, please include it here or as a separate email. And when you explain them... remember who you are talking to :) Thanks, Scott I don't fully understand them either. I can do the digging, but perhaps someone else already familiar with them could comment and help flesh this out. Just put a plea for help up on the discussion mailing list. Scott I have upadated the introductory to both the MACHINE_FEATURES and DISTRO_FEATURES list sections in the reference manual to provide a bit more information on how including a feature might affect the build. I used information from Paul Eggleton from an email thread a while back. See http://www.yoctoproject.org/docs/1.4/poky-ref-manual/poky-ref-manual.html#ref-features-machine and http://www.yoctoproject.org/docs/1.4/poky-ref-manual/poky-ref-manual.html#ref-features-distro. I also included a practical example in the glossary description for MACHINE_FEATURES based on input from Ross Burton. You can see that at http://www.yoctoproject.org/docs/1.4/poky-ref-manual/poky-ref-manual.html#var-MACHINE_FEATURES. I do not understand the "git grep 'contains.*MACHINE_FEATURES.*<FEATURE>'" example that Darren Hart provided in Comment #0. How is this different than simply grep'ing for MACHINE_FEATURES? I would like to provide some tools as Darren suggests for the user to use to see the effects of including a specific feature but I need some more understanding of it. Can someone provide more examples or more explanation of the example Darren included? Once I get that piece in I will consider this bug closed. Thanks, Scott The grep command in comment 0 searches for places in the meta-data where the recipes are checking to see that a specific FEATURE is contained in the MACHINE_FEATURES variable. This will point you at the recipes who's build is potentially changed based on a given FEATURE. I updated the introduction area of the Features chapter in the poky-ref-manual to include the grep example in Comment #0. This change needs approved for accuracy. See http://www.yoctoproject.org/docs/1.4/poky-ref-manual/poky-ref-manual.html#ref-features Scott No further comments on the fix since mid-november so I am closing it. Scott |