From 0c0ac7dd3af04610ca740817224d8c57ccd2fba5 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Tue, 13 Aug 2013 15:15:55 +0300
Subject: ref-manual: Updates to insane.bbclass and two new variables added.

* Updated the insane.bbclass section to move the note at the
  end about using ERROR_QA and WARN_QA to control how the
  checks are reported to the front of the section.

* Added new variable entries for WARN_QA and ERROR_QA.

(From yocto-docs rev: 6f220d1ba3d44a1bba2f1ac882cdf6b601ddc5bb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/ref-classes.xml   | 58 +++++++++++++++---------------
 documentation/ref-manual/ref-variables.xml | 32 ++++++++++++++++-
 2 files changed, 60 insertions(+), 30 deletions(-)

(limited to 'documentation')

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 7a5a5ddb58..5d1e3ed1b4 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -466,20 +466,39 @@
     </para>
 
     <para>
-        You can configure the sanity checks so that specific test failures either raise a warning or
-        an error message.
+        You can configure the sanity checks so that specific test failures
+        either raise a warning or an error message.
         Typically, failures for new tests generate a warning.
-        Subsequent failures for the same test would then generate an error message
-        once the metadata is in a known and good condition.
-        You use the <filename>WARN_QA</filename> variable to specify tests for which you
-        want to generate a warning message on failure.
-        You use the <filename>ERROR_QA</filename> variable to specify tests for which you
-        want to generate an error message on failure.
+        Subsequent failures for the same test would then generate an error
+        message once the metadata is in a known and good condition.
     </para>
 
     <para>
-        The following list shows the tests you can list with the <filename>WARN_QA</filename>
-        and <filename>ERROR_QA</filename> variables:
+        Use the
+        <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and
+        <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link>
+         variables to control the behavior of
+        these checks at the global level (i.e. in your custom distro
+        configuration).
+        However, to skip one or more checks in recipes, you should use
+        <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>.
+        For example, to skip the check for symbolic link
+        <filename>.so</filename> files in the main package of a recipe,
+        add the following to the recipe.
+        You need to realize that the package name override, in this example
+        <filename>${PN}</filename>, must be used:
+        <literallayout class='monospaced'>
+     INSANE_SKIP_${PN} += "dev-so"
+        </literallayout>
+        Please keep in mind that the QA checks exist in order to detect real
+        or potential problems in the packaged output.
+        So exercise caution when disabling these checks.
+    </para>
+
+    <para>
+        The following list shows the tests you can list with the
+        <filename>WARN_QA</filename> and <filename>ERROR_QA</filename>
+        variables:
         <itemizedlist>
             <listitem><para><emphasis><filename>ldflags:</filename></emphasis>
                 Ensures that the binaries were linked with the
@@ -780,25 +799,6 @@
                 </para></listitem>
         </itemizedlist>
     </para>
-    <note>
-        You can use the <filename>WARN_QA</filename> and
-        <filename>ERROR_QA</filename> variables to control the behavior of
-        these checks at the global level (i.e. in your custom distro
-        configuration).
-        However, to skip one or more checks in recipes, you should use
-        <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>.
-        For example, to skip the check for symbolic link
-        <filename>.so</filename> files in the main package of a recipe,
-        add the following to the recipe.
-        You need to realize that the package name override, in this example
-        <filename>${PN}</filename>, must be used:
-        <literallayout class='monospaced'>
-     INSANE_SKIP_${PN} += "dev-so"
-        </literallayout>
-        Please keep in mind that the QA checks exist in order to detect real
-        or potential problems in the packaged output.
-        So exercise caution when disabling these checks.
-    </note>
 </section>
 
 <section id='ref-classes-rm-work'>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 099846412b..266e18f7ea 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -38,7 +38,7 @@
        <link linkend='var-T'>T</link>
 <!--               <link linkend='var-glossary-u'>U</link> -->
 <!--               <link linkend='var-glossary-v'>V</link> -->
-       <link linkend='var-WORKDIR'>W</link>
+       <link linkend='var-WARN_QA'>W</link>
 <!--               <link linkend='var-glossary-x'>X</link> -->
 <!--               <link linkend='var-glossary-y'>Y</link> -->
 <!--               <link linkend='var-glossary-z'>Z</link>-->
@@ -1199,6 +1199,21 @@ Core layer for images cannot be removed
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-ERROR_QA'><glossterm>ERROR_QA</glossterm>
+            <glossdef>
+                <para>
+                    Specifies the quality assurance checks whose failures are
+                    reported as errors by the OpenEmbedded build system.
+                    You set this variable in your distribution configuration
+                    file.
+                    For a list of the checks you can control with this variable,
+                    see the
+                    "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
+                    section.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm>
             <glossdef>
                 <para>
@@ -4771,6 +4786,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
 
     <glossdiv id='var-glossary-w'><title>W</title>
 
+        <glossentry id='var-WARN_QA'><glossterm>WARN_QA</glossterm>
+            <glossdef>
+                <para>
+                    Specifies the quality assurance checks whose failures are
+                    reported as warnings by the OpenEmbedded build system.
+                    You set this variable in your distribution configuration
+                    file.
+                    For a list of the checks you can control with this variable,
+                    see the
+                    "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
+                    section.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm>
             <glossdef>
                 <para>
-- 
cgit v1.2.3-54-g00ecf