From acdafd5ff70cd7f81e5df00c76b4e92179797cda Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 28 May 2014 11:01:27 +0300 Subject: ref-manual: Edits to the QA checks message section and insane.bbclass. Fixes [YOCTO #6159] I applied some review edits to various parts of the QA chapter as derived by Paul Eggleton. Also, updated two areas of the insane.bbclass list. (From yocto-docs rev: 6529a261961339b747bb3b89b3080ef794244809) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-qa-checks.xml | 55 ++++++++++++++++++------------ 1 file changed, 34 insertions(+), 21 deletions(-) (limited to 'documentation/ref-manual/ref-qa-checks.xml') diff --git a/documentation/ref-manual/ref-qa-checks.xml b/documentation/ref-manual/ref-qa-checks.xml index c31f9c792f..5f31dcd06a 100644 --- a/documentation/ref-manual/ref-qa-checks.xml +++ b/documentation/ref-manual/ref-qa-checks.xml @@ -12,10 +12,10 @@ When building a recipe, the OpenEmbedded build system performs various QA checks on the output to ensure that common issues are detected and reported. - Some software builds that use new recipes complete with no problems. - However, some do not. - When issues are reported, it could take a little time - to resolve them. + Sometimes when you create a new recipe to build new software, + it will build with no problems. + When this is not the case, or when you have QA issues building any + software, it could take a little time to resolve them. @@ -36,7 +36,7 @@ Notes - At the end of each message, the name of the offending + At the end of each message, the name of the associated QA test (as listed in the "insane.bbclass" section) appears within square brackets. @@ -595,8 +595,9 @@ (i.e. a package whose name does not end in -dbg) and a package that is a dbg package. - The dbg packages contain debug symbols - that are brought in a number of ways: + The dbg packages contain + debug symbols and are brought in using several + different methods: Using the dbg-pkgs @@ -608,9 +609,9 @@ IMAGE_INSTALL. - Using either of the previous methods - as a dependency of another - dbg package. + As a dependency of another + dbg package that was brought + in using one of the above methods. The dependency might have been automatically added @@ -643,13 +644,24 @@ -dev) and a package that is a dev package. The dev packages contain development - headers and are usually brought in using the - dev-pkgs - IMAGE_FEATURES - value or explicitly brought into the image using - IMAGE_INSTALL - (or as a dependency of another dev - package brought in using either method). + headers and are usually brought in using several different + methods: + + + Using the dev-pkgs + IMAGE_FEATURES + value. + + + Using + IMAGE_INSTALL. + + + As a dependency of another + dev package that was brought + in using one of the above methods. + + The dependency might have been automatically added (because the dev package erroneously contains files that it should not have (e.g. a non-symlink @@ -1115,12 +1127,13 @@ enabled by default: Configuring and Disabling QA Checks - You can configure the sanity checks so that specific test failures - either raise a warning or an error message. - You can also use the + You can configure the QA checks globally so that specific check + failures either raise a warning or an error message, using the WARN_QA and ERROR_QA - variables to configure warning and error reporting. + variables, respectively. + You can also disable checks within a particular recipe using + INSANE_SKIP. For information on how to work with the QA checks, see the "insane.bbclass" section. -- cgit v1.2.3-54-g00ecf