mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-02-28 12:29:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: Edits to the QA checks message section and insane.bbclass.

Browse Source 
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>
This commit is contained in:
Scott Rifenbark
2014-05-28 11:01:27 +03:00
committed by Richard Purdie
parent 3dd477c469
commit acdafd5ff7
2 changed files with 40 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
documentation/ref-manual/ref-classes.xml
View File

@@ -1328,9 +1328,9 @@
</para></listitem>
<listitem><para><emphasis><filename>debug-deps:</filename></emphasis>
Checks that all packages except <filename>-dbg</filename>
packages only depend on other <filename>-dbg</filename>
packages and not on any other types of packages,
which would cause a packaging bug.</para></listitem>
packages do not depend on <filename>-dbg</filename>
packages, which would cause a packaging bug.
</para></listitem>
<listitem><para><emphasis><filename>debug-files:</filename></emphasis>
Checks for <filename>.debug</filename> directories in anything but the
<filename>-dbg</filename> package.
@@ -1357,9 +1357,9 @@
<filename>.desktop</filename> files.</para></listitem>
<listitem><para><emphasis><filename>dev-deps:</filename></emphasis>
Checks that all packages except <filename>-dev</filename>
or <filename>-staticdev</filename> packages depend on
<filename>-dev</filename> packages and not on any other types
of packages, which would be a packaging bug.</para></listitem>
or <filename>-staticdev</filename> packages do not depend on
<filename>-dev</filename> packages, which would be a
packaging bug.</para></listitem>
<listitem><para><emphasis><filename>dev-so:</filename></emphasis>
Checks that the <filename>.so</filename> symbolic links are in the
<filename>-dev</filename> package and not in any of the other packages.

55
documentation/ref-manual/ref-qa-checks.xml
View File

@@ -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.
</para>
<para>
@@ -36,7 +36,7 @@
<title>Notes</title>
<itemizedlist>
<listitem><para>
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
"<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
section) appears within square brackets.
@@ -595,8 +595,9 @@
(i.e. a package whose name does not end in
<filename>-dbg</filename>) and a package that is a
<filename>dbg</filename> package.
The <filename>dbg</filename> packages contain debug symbols
that are brought in a number of ways:
The <filename>dbg</filename> packages contain
debug symbols and are brought in using several
different methods:
<itemizedlist>
<listitem><para>
Using the <filename>dbg-pkgs</filename>
@@ -608,9 +609,9 @@
<link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>.
</para></listitem>
<listitem><para>
Using either of the previous methods
as a dependency of another
<filename>dbg</filename> package.
As a dependency of another
<filename>dbg</filename> package that was brought
in using one of the above methods.
</para></listitem>
</itemizedlist>
The dependency might have been automatically added
@@ -643,13 +644,24 @@
<filename>-dev</filename>) and a package that is a
<filename>dev</filename> package.
The <filename>dev</filename> packages contain development
headers and are usually brought in using the
<filename>dev-pkgs</filename>
<link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
value or explicitly brought into the image using
<link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>
(or as a dependency of another <filename>dev</filename>
package brought in using either method).
headers and are usually brought in using several different
methods:
<itemizedlist>
<listitem><para>
Using the <filename>dev-pkgs</filename>
<link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
value.
</para></listitem>
<listitem><para>
Using
<link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>.
</para></listitem>
<listitem><para>
As a dependency of another
<filename>dev</filename> package that was brought
in using one of the above methods.
</para></listitem>
</itemizedlist>
The dependency might have been automatically added (because
the <filename>dev</filename> package erroneously contains
files that it should not have (e.g. a non-symlink
@@ -1115,12 +1127,13 @@ enabled by default:
<title>Configuring and Disabling QA Checks</title>
<para>
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
<link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and
<link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link>
variables to configure warning and error reporting.
variables, respectively.
You can also disable checks within a particular recipe using
<link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>.
For information on how to work with the QA checks, see the
"<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>"
section.