Bug 10763

Summary: recipetool example is incorrect
Product: [Documentation] Development Manual Reporter: Martin Vuille <martin_vuille>
Component: developmentAssignee: Scott Rifenbark <srifenbark>
Status: VERIFIED FIXED QA Contact: David Lopez Barriba <davidx.lopez.barriba>
Severity: normal    
Priority: Medium+ CC: bluelightning, jose.perez.carranza, srifenbark
Version: 2.2   
Target Milestone: 2.3 M3   
Hardware: All   
OS: Multiple   
Whiteboard: 16 Feb 2017: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)

Description Martin Vuille 2016-12-05 13:12:13 UTC
Section 5.3.2.2

Description of third example states "The options direct recipetool to run in "quiet mode" and to generate debugging information."

However, neither "-q" nor "-d" options are present in the actual example; "recipetool create -o OUTFILE source"

Will submit patch, please advise what mailing list to use.
Comment 1 Scott Rifenbark 2016-12-06 21:23:52 UTC
Martin, 

If you want, you can just type in the example here in Bugzilla as a comment and I can get the change in.  When I submit the commit I will --author it to you.

Or, if you want to submit a patch send it to the yocto mailing list.  You should copy me at srifenbark@gmail.com

Thanks,
Scott
Comment 2 Martin Vuille 2016-12-10 18:36:54 UTC
Scott,

To match the description, the example would have to be

"recipetool create -q -d -o OUTFILE source"

But there's a hitch: it makes no sense to put both "-q" and "-d" together, as "-d" seems to negate the effect of "-q".

My suggestion is to change the description to say "The options direct recipetool to generate debugging information." and to change the example to "recipetool create -d -o OUTFILE source"

MV
Comment 3 Scott Rifenbark 2016-12-29 18:57:54 UTC
Martin, 

Thanks for the additional information. See http://www.yoctoproject.org/docs/2.3/dev-manual/dev-manual.html#new-recipe-creating-the-base-recipe-using-recipetool for the changes and let me know if they are okay.  Once they are, I will take steps to close out the bug.

Thanks, 
Scott
Comment 4 Scott Rifenbark 2017-02-16 19:17:04 UTC
No additional review since end of December.  I am marking the bug RESOLVED and setting the doc flag to "done."

Scott
Comment 5 David Lopez Barriba 2017-05-25 22:05:32 UTC
Verified