Bug 6159

Summary: Document how to resolve QA issues
Product: [Documentation] Development Manual Reporter: Paul Eggleton <bluelightning>
Component: developmentAssignee: Scott Rifenbark <srifenbark>
Status: VERIFIED FIXED QA Contact: Bogdan Alexandru Voiculescu <bogdanx.a.voiculescu>
Severity: enhancement    
Priority: High CC: bluelightning, bogdanx.a.voiculescu, srifenbark
Version: unspecified   
Target Milestone: 1.7 M2   
Hardware: All   
OS: Multiple   
Whiteboard: 02 June 2014: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)
Attachments:
Description Flags
List of QA checks and descriptions none

Description Paul Eggleton 2014-04-14 10:46:05 UTC 
We have a reference section for insane.bbclass, but this doesn't tell you how to actually resolve them; and for new users fixing QA issues can represent a significant amount of time spent when writing a new recipe. Worse still, in the absence of documentation on how to fix the issues, users can be tempted to just ignore or disable the QA checks entirely. We should have a section listing the QA failure messages that get printed, and for each one an explanation of the issue that is being checked for and what needs to be done to resolve it properly. I can provide all of the background information for this.

(I'm not sure if this would fully replace the insane.bbclass reference listing all checks by name, since having that reference may also be useful e.g. if you're looking through the list of checks in ERROR_QA/WARN_QA and want to know what they mean.)
Comment 1 Scott Rifenbark 2014-05-19 08:36:45 UTC 
I think it is good to keep the list in the insane.bbclass reference.  I can get working on this when I start getting some information on how to actually interpret and deal with the QA messages and issues. 

Scott
Comment 2 Paul Eggleton 2014-05-20 14:50:05 UTC 
Created attachment 1969 [details]
List of QA checks and descriptions
Comment 3 Paul Eggleton 2014-05-20 14:50:38 UTC 
I've attached a list of QA issue messages and for each one a description of what the failure means, plus in most cases hints on how you would go about fixing it.
Comment 4 Scott Rifenbark 2014-05-22 08:26:27 UTC 
Hi, 

See the http://www.yoctoproject.org/docs/1.7/ref-manual/ref-manual.html#ref-qa-checks link to see the new QA messages chapter in the ref-manual.  Once the content is approved, I will move the bug to RESOLVED.

Scott
Comment 5 Scott Rifenbark 2014-05-22 08:27:27 UTC 
Setting target milestone to 1.7 M2.
Comment 6 Scott Rifenbark 2014-05-28 08:34:03 UTC 
I have added some edits to the new section as directed by Paul Eggleton's review.  Once these are approved (via his email).  I will mark the bug as RESOLVED and flip the doc flag to "Done."

Scott
Comment 7 Scott Rifenbark 2014-06-02 13:19:39 UTC 
Hi, 

All review comments in and approved.  Marking as RESOLVED and flipping the doc flag to "Done."

Scott
Comment 8 Bogdan Alexandru Voiculescu 2014-10-08 12:53:47 UTC 
Documentation is present and reviewed.