ref-manual: Added 3 new QA sanity checks.

Fixes [YOCTO #9983]

Added the host-user-contaminated, invalid-chars, and invalid-packageconfig
QA checks.

(From yocto-docs rev: 5bd28f9386a8afff435254788fbce73a7fc48305)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2016-07-19 13:48:26 -07:00 committed by Richard Purdie
parent f2fa3c59bb
commit 33b01c502f
2 changed files with 32 additions and 1 deletions

View File

@ -1606,6 +1606,17 @@
<link linkend='var-FILES'><filename>FILES</filename></link>
variable values that contain "//", which is invalid.
</para></listitem>
<listitem><para><emphasis><filename>host-user-contaminated:</filename></emphasis>
Checks that no package produced by the recipe contains any
files outside of <filename>/home</filename> with a user or
group ID that matches the user running BitBake.
A match usually indicates that the files are being installed
with an incorrect UID/GID, since target IDs are independent
from host IDs.
For additional information, see the section describing the
<link linkend='ref-tasks-install'><filename>do_install</filename></link>
task.
</para></listitem>
<listitem><para><emphasis><filename>incompatible-license:</filename></emphasis>
Report when packages are excluded from being created due to
being marked with a license that is in
@ -1633,6 +1644,25 @@
<filename>do_install</filename> if the files are not
needed in any package.
</para></listitem>
<listitem><para><emphasis><filename>invalid-chars:</filename></emphasis>
Checks that the recipe metadata variables
<link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link>,
<link linkend='var-SUMMARY'><filename>SUMMARY</filename></link>,
<link linkend='var-LICENSE'><filename>LICENSE</filename></link>,
and
<link linkend='var-SECTION'><filename>SECTION</filename></link>
do not contain non-UTF-8 characters.
Some package managers do not support such characters.
</para></listitem>
<listitem><para><emphasis><filename>invalid-packageconfig:</filename></emphasis>
Checks that no undefined features are being added to
<link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>.
For example, any name "foo" for which the following form
does not exist:
<literallayout class='monospaced'>
PACKAGECONFIG[foo] = "..."
</literallayout>
</para></listitem>
<listitem><para><emphasis><filename>la:</filename></emphasis>
Checks <filename>.la</filename> files for any <filename>TMPDIR</filename>
paths.

View File

@ -300,7 +300,8 @@
recursive <filename>cp</filename> command, can preserve the
UID and/or GID of the original file, which is usually not
what you want.
The <filename>host-user-contaminated</filename>
The
<link linkend='ref-classes-insane'><filename>host-user-contaminated</filename></link>
QA check checks for files that probably have the wrong
ownership.
</para>