summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-05-28 11:01:27 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-05-30 16:32:15 +0100
commitacdafd5ff70cd7f81e5df00c76b4e92179797cda (patch)
treeae9e5f9cb31934199f055f37b2e5f2d4a73b2e62
parent3dd477c469af888cb222c160a5fda0f335c97acd (diff)
downloadpoky-acdafd5ff70cd7f81e5df00c76b4e92179797cda.tar.gz
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 <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-classes.xml12
-rw-r--r--documentation/ref-manual/ref-qa-checks.xml55
2 files changed, 40 insertions, 27 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index d00f00d3b2..706392488f 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1328,9 +1328,9 @@
1328 </para></listitem> 1328 </para></listitem>
1329 <listitem><para><emphasis><filename>debug-deps:</filename></emphasis> 1329 <listitem><para><emphasis><filename>debug-deps:</filename></emphasis>
1330 Checks that all packages except <filename>-dbg</filename> 1330 Checks that all packages except <filename>-dbg</filename>
1331 packages only depend on other <filename>-dbg</filename> 1331 packages do not depend on <filename>-dbg</filename>
1332 packages and not on any other types of packages, 1332 packages, which would cause a packaging bug.
1333 which would cause a packaging bug.</para></listitem> 1333 </para></listitem>
1334 <listitem><para><emphasis><filename>debug-files:</filename></emphasis> 1334 <listitem><para><emphasis><filename>debug-files:</filename></emphasis>
1335 Checks for <filename>.debug</filename> directories in anything but the 1335 Checks for <filename>.debug</filename> directories in anything but the
1336 <filename>-dbg</filename> package. 1336 <filename>-dbg</filename> package.
@@ -1357,9 +1357,9 @@
1357 <filename>.desktop</filename> files.</para></listitem> 1357 <filename>.desktop</filename> files.</para></listitem>
1358 <listitem><para><emphasis><filename>dev-deps:</filename></emphasis> 1358 <listitem><para><emphasis><filename>dev-deps:</filename></emphasis>
1359 Checks that all packages except <filename>-dev</filename> 1359 Checks that all packages except <filename>-dev</filename>
1360 or <filename>-staticdev</filename> packages depend on 1360 or <filename>-staticdev</filename> packages do not depend on
1361 <filename>-dev</filename> packages and not on any other types 1361 <filename>-dev</filename> packages, which would be a
1362 of packages, which would be a packaging bug.</para></listitem> 1362 packaging bug.</para></listitem>
1363 <listitem><para><emphasis><filename>dev-so:</filename></emphasis> 1363 <listitem><para><emphasis><filename>dev-so:</filename></emphasis>
1364 Checks that the <filename>.so</filename> symbolic links are in the 1364 Checks that the <filename>.so</filename> symbolic links are in the
1365 <filename>-dev</filename> package and not in any of the other packages. 1365 <filename>-dev</filename> package and not in any of the other packages.
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 @@
12 When building a recipe, the OpenEmbedded build system performs 12 When building a recipe, the OpenEmbedded build system performs
13 various QA checks on the output to ensure that common issues are 13 various QA checks on the output to ensure that common issues are
14 detected and reported. 14 detected and reported.
15 Some software builds that use new recipes complete with no problems. 15 Sometimes when you create a new recipe to build new software,
16 However, some do not. 16 it will build with no problems.
17 When issues are reported, it could take a little time 17 When this is not the case, or when you have QA issues building any
18 to resolve them. 18 software, it could take a little time to resolve them.
19 </para> 19 </para>
20 20
21 <para> 21 <para>
@@ -36,7 +36,7 @@
36 <title>Notes</title> 36 <title>Notes</title>
37 <itemizedlist> 37 <itemizedlist>
38 <listitem><para> 38 <listitem><para>
39 At the end of each message, the name of the offending 39 At the end of each message, the name of the associated
40 QA test (as listed in the 40 QA test (as listed in the
41 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" 41 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
42 section) appears within square brackets. 42 section) appears within square brackets.
@@ -595,8 +595,9 @@
595 (i.e. a package whose name does not end in 595 (i.e. a package whose name does not end in
596 <filename>-dbg</filename>) and a package that is a 596 <filename>-dbg</filename>) and a package that is a
597 <filename>dbg</filename> package. 597 <filename>dbg</filename> package.
598 The <filename>dbg</filename> packages contain debug symbols 598 The <filename>dbg</filename> packages contain
599 that are brought in a number of ways: 599 debug symbols and are brought in using several
600 different methods:
600 <itemizedlist> 601 <itemizedlist>
601 <listitem><para> 602 <listitem><para>
602 Using the <filename>dbg-pkgs</filename> 603 Using the <filename>dbg-pkgs</filename>
@@ -608,9 +609,9 @@
608 <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>. 609 <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>.
609 </para></listitem> 610 </para></listitem>
610 <listitem><para> 611 <listitem><para>
611 Using either of the previous methods 612 As a dependency of another
612 as a dependency of another 613 <filename>dbg</filename> package that was brought
613 <filename>dbg</filename> package. 614 in using one of the above methods.
614 </para></listitem> 615 </para></listitem>
615 </itemizedlist> 616 </itemizedlist>
616 The dependency might have been automatically added 617 The dependency might have been automatically added
@@ -643,13 +644,24 @@
643 <filename>-dev</filename>) and a package that is a 644 <filename>-dev</filename>) and a package that is a
644 <filename>dev</filename> package. 645 <filename>dev</filename> package.
645 The <filename>dev</filename> packages contain development 646 The <filename>dev</filename> packages contain development
646 headers and are usually brought in using the 647 headers and are usually brought in using several different
647 <filename>dev-pkgs</filename> 648 methods:
648 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> 649 <itemizedlist>
649 value or explicitly brought into the image using 650 <listitem><para>
650 <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link> 651 Using the <filename>dev-pkgs</filename>
651 (or as a dependency of another <filename>dev</filename> 652 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
652 package brought in using either method). 653 value.
654 </para></listitem>
655 <listitem><para>
656 Using
657 <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>.
658 </para></listitem>
659 <listitem><para>
660 As a dependency of another
661 <filename>dev</filename> package that was brought
662 in using one of the above methods.
663 </para></listitem>
664 </itemizedlist>
653 The dependency might have been automatically added (because 665 The dependency might have been automatically added (because
654 the <filename>dev</filename> package erroneously contains 666 the <filename>dev</filename> package erroneously contains
655 files that it should not have (e.g. a non-symlink 667 files that it should not have (e.g. a non-symlink
@@ -1115,12 +1127,13 @@ enabled by default:
1115 <title>Configuring and Disabling QA Checks</title> 1127 <title>Configuring and Disabling QA Checks</title>
1116 1128
1117 <para> 1129 <para>
1118 You can configure the sanity checks so that specific test failures 1130 You can configure the QA checks globally so that specific check
1119 either raise a warning or an error message. 1131 failures either raise a warning or an error message, using the
1120 You can also use the
1121 <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and 1132 <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and
1122 <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link> 1133 <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link>
1123 variables to configure warning and error reporting. 1134 variables, respectively.
1135 You can also disable checks within a particular recipe using
1136 <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>.
1124 For information on how to work with the QA checks, see the 1137 For information on how to work with the QA checks, see the
1125 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" 1138 "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
1126 section. 1139 section.