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.)
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
Created attachment 1969 [details] List of QA checks and descriptions
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.
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
Setting target milestone to 1.7 M2.
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
Hi, All review comments in and approved. Marking as RESOLVED and flipping the doc flag to "Done." Scott
Documentation is present and reviewed.