ref-manual/ref-classes: add note to insane.bbclass section on INSANE_SKIP

Performed a few edits to clean up some sentences.  Broke one long
sentence up into two.

(From yocto-docs rev: 7641113906e062b751abb5366827fe302ec4a2b9)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton 2013-04-09 11:42:23 +01:00 committed by Richard Purdie
parent 0ffd01f835
commit 411022f8dd
1 changed files with 19 additions and 0 deletions

View File

@ -584,6 +584,25 @@
the specification for <filename>.desktop</filename> files.</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
<filename>INSANE_SKIP</filename>.
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'>