diff options
| -rw-r--r-- | documentation/ref-manual/ref-classes.xml | 58 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 32 |
2 files changed, 60 insertions, 30 deletions
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 @@ | |||
| 466 | </para> | 466 | </para> |
| 467 | 467 | ||
| 468 | <para> | 468 | <para> |
| 469 | You can configure the sanity checks so that specific test failures either raise a warning or | 469 | You can configure the sanity checks so that specific test failures |
| 470 | an error message. | 470 | either raise a warning or an error message. |
| 471 | Typically, failures for new tests generate a warning. | 471 | Typically, failures for new tests generate a warning. |
| 472 | Subsequent failures for the same test would then generate an error message | 472 | Subsequent failures for the same test would then generate an error |
| 473 | once the metadata is in a known and good condition. | 473 | message once the metadata is in a known and good condition. |
| 474 | You use the <filename>WARN_QA</filename> variable to specify tests for which you | ||
| 475 | want to generate a warning message on failure. | ||
| 476 | You use the <filename>ERROR_QA</filename> variable to specify tests for which you | ||
| 477 | want to generate an error message on failure. | ||
| 478 | </para> | 474 | </para> |
| 479 | 475 | ||
| 480 | <para> | 476 | <para> |
| 481 | The following list shows the tests you can list with the <filename>WARN_QA</filename> | 477 | Use the |
| 482 | and <filename>ERROR_QA</filename> variables: | 478 | <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and |
| 479 | <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link> | ||
| 480 | variables to control the behavior of | ||
| 481 | these checks at the global level (i.e. in your custom distro | ||
| 482 | configuration). | ||
| 483 | However, to skip one or more checks in recipes, you should use | ||
| 484 | <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>. | ||
| 485 | For example, to skip the check for symbolic link | ||
| 486 | <filename>.so</filename> files in the main package of a recipe, | ||
| 487 | add the following to the recipe. | ||
| 488 | You need to realize that the package name override, in this example | ||
| 489 | <filename>${PN}</filename>, must be used: | ||
| 490 | <literallayout class='monospaced'> | ||
| 491 | INSANE_SKIP_${PN} += "dev-so" | ||
| 492 | </literallayout> | ||
| 493 | Please keep in mind that the QA checks exist in order to detect real | ||
| 494 | or potential problems in the packaged output. | ||
| 495 | So exercise caution when disabling these checks. | ||
| 496 | </para> | ||
| 497 | |||
| 498 | <para> | ||
| 499 | The following list shows the tests you can list with the | ||
| 500 | <filename>WARN_QA</filename> and <filename>ERROR_QA</filename> | ||
| 501 | variables: | ||
| 483 | <itemizedlist> | 502 | <itemizedlist> |
| 484 | <listitem><para><emphasis><filename>ldflags:</filename></emphasis> | 503 | <listitem><para><emphasis><filename>ldflags:</filename></emphasis> |
| 485 | Ensures that the binaries were linked with the | 504 | Ensures that the binaries were linked with the |
| @@ -780,25 +799,6 @@ | |||
| 780 | </para></listitem> | 799 | </para></listitem> |
| 781 | </itemizedlist> | 800 | </itemizedlist> |
| 782 | </para> | 801 | </para> |
| 783 | <note> | ||
| 784 | You can use the <filename>WARN_QA</filename> and | ||
| 785 | <filename>ERROR_QA</filename> variables to control the behavior of | ||
| 786 | these checks at the global level (i.e. in your custom distro | ||
| 787 | configuration). | ||
| 788 | However, to skip one or more checks in recipes, you should use | ||
| 789 | <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>. | ||
| 790 | For example, to skip the check for symbolic link | ||
| 791 | <filename>.so</filename> files in the main package of a recipe, | ||
| 792 | add the following to the recipe. | ||
| 793 | You need to realize that the package name override, in this example | ||
| 794 | <filename>${PN}</filename>, must be used: | ||
| 795 | <literallayout class='monospaced'> | ||
| 796 | INSANE_SKIP_${PN} += "dev-so" | ||
| 797 | </literallayout> | ||
| 798 | Please keep in mind that the QA checks exist in order to detect real | ||
| 799 | or potential problems in the packaged output. | ||
| 800 | So exercise caution when disabling these checks. | ||
| 801 | </note> | ||
| 802 | </section> | 802 | </section> |
| 803 | 803 | ||
| 804 | <section id='ref-classes-rm-work'> | 804 | <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 @@ | |||
| 38 | <link linkend='var-T'>T</link> | 38 | <link linkend='var-T'>T</link> |
| 39 | <!-- <link linkend='var-glossary-u'>U</link> --> | 39 | <!-- <link linkend='var-glossary-u'>U</link> --> |
| 40 | <!-- <link linkend='var-glossary-v'>V</link> --> | 40 | <!-- <link linkend='var-glossary-v'>V</link> --> |
| 41 | <link linkend='var-WORKDIR'>W</link> | 41 | <link linkend='var-WARN_QA'>W</link> |
| 42 | <!-- <link linkend='var-glossary-x'>X</link> --> | 42 | <!-- <link linkend='var-glossary-x'>X</link> --> |
| 43 | <!-- <link linkend='var-glossary-y'>Y</link> --> | 43 | <!-- <link linkend='var-glossary-y'>Y</link> --> |
| 44 | <!-- <link linkend='var-glossary-z'>Z</link>--> | 44 | <!-- <link linkend='var-glossary-z'>Z</link>--> |
| @@ -1199,6 +1199,21 @@ Core layer for images cannot be removed | |||
| 1199 | </glossdef> | 1199 | </glossdef> |
| 1200 | </glossentry> | 1200 | </glossentry> |
| 1201 | 1201 | ||
| 1202 | <glossentry id='var-ERROR_QA'><glossterm>ERROR_QA</glossterm> | ||
| 1203 | <glossdef> | ||
| 1204 | <para> | ||
| 1205 | Specifies the quality assurance checks whose failures are | ||
| 1206 | reported as errors by the OpenEmbedded build system. | ||
| 1207 | You set this variable in your distribution configuration | ||
| 1208 | file. | ||
| 1209 | For a list of the checks you can control with this variable, | ||
| 1210 | see the | ||
| 1211 | "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" | ||
| 1212 | section. | ||
| 1213 | </para> | ||
| 1214 | </glossdef> | ||
| 1215 | </glossentry> | ||
| 1216 | |||
| 1202 | <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm> | 1217 | <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm> |
| 1203 | <glossdef> | 1218 | <glossdef> |
| 1204 | <para> | 1219 | <para> |
| @@ -4771,6 +4786,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 4771 | 4786 | ||
| 4772 | <glossdiv id='var-glossary-w'><title>W</title> | 4787 | <glossdiv id='var-glossary-w'><title>W</title> |
| 4773 | 4788 | ||
| 4789 | <glossentry id='var-WARN_QA'><glossterm>WARN_QA</glossterm> | ||
| 4790 | <glossdef> | ||
| 4791 | <para> | ||
| 4792 | Specifies the quality assurance checks whose failures are | ||
| 4793 | reported as warnings by the OpenEmbedded build system. | ||
| 4794 | You set this variable in your distribution configuration | ||
| 4795 | file. | ||
| 4796 | For a list of the checks you can control with this variable, | ||
| 4797 | see the | ||
| 4798 | "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" | ||
| 4799 | section. | ||
| 4800 | </para> | ||
| 4801 | </glossdef> | ||
| 4802 | </glossentry> | ||
| 4803 | |||
| 4774 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> | 4804 | <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> |
| 4775 | <glossdef> | 4805 | <glossdef> |
| 4776 | <para> | 4806 | <para> |
