summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-07-19 13:48:26 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-08-01 12:15:00 +0100
commit33b01c502fa0e408a1f18631454af739dbd2adb4 (patch)
tree5d217d21aa71845878a9f41eb6fd9efff27a3567 /documentation
parentf2fa3c59bbbabf0eeee12b3d853529b046b7a719 (diff)
downloadpoky-33b01c502fa0e408a1f18631454af739dbd2adb4.tar.gz
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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-classes.xml30
-rw-r--r--documentation/ref-manual/ref-tasks.xml3
2 files changed, 32 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index c58c56755b..1d6c45d356 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1606,6 +1606,17 @@
1606 <link linkend='var-FILES'><filename>FILES</filename></link> 1606 <link linkend='var-FILES'><filename>FILES</filename></link>
1607 variable values that contain "//", which is invalid. 1607 variable values that contain "//", which is invalid.
1608 </para></listitem> 1608 </para></listitem>
1609 <listitem><para><emphasis><filename>host-user-contaminated:</filename></emphasis>
1610 Checks that no package produced by the recipe contains any
1611 files outside of <filename>/home</filename> with a user or
1612 group ID that matches the user running BitBake.
1613 A match usually indicates that the files are being installed
1614 with an incorrect UID/GID, since target IDs are independent
1615 from host IDs.
1616 For additional information, see the section describing the
1617 <link linkend='ref-tasks-install'><filename>do_install</filename></link>
1618 task.
1619 </para></listitem>
1609 <listitem><para><emphasis><filename>incompatible-license:</filename></emphasis> 1620 <listitem><para><emphasis><filename>incompatible-license:</filename></emphasis>
1610 Report when packages are excluded from being created due to 1621 Report when packages are excluded from being created due to
1611 being marked with a license that is in 1622 being marked with a license that is in
@@ -1633,6 +1644,25 @@
1633 <filename>do_install</filename> if the files are not 1644 <filename>do_install</filename> if the files are not
1634 needed in any package. 1645 needed in any package.
1635 </para></listitem> 1646 </para></listitem>
1647 <listitem><para><emphasis><filename>invalid-chars:</filename></emphasis>
1648 Checks that the recipe metadata variables
1649 <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link>,
1650 <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link>,
1651 <link linkend='var-LICENSE'><filename>LICENSE</filename></link>,
1652 and
1653 <link linkend='var-SECTION'><filename>SECTION</filename></link>
1654 do not contain non-UTF-8 characters.
1655 Some package managers do not support such characters.
1656 </para></listitem>
1657 <listitem><para><emphasis><filename>invalid-packageconfig:</filename></emphasis>
1658 Checks that no undefined features are being added to
1659 <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>.
1660 For example, any name "foo" for which the following form
1661 does not exist:
1662 <literallayout class='monospaced'>
1663 PACKAGECONFIG[foo] = "..."
1664 </literallayout>
1665 </para></listitem>
1636 <listitem><para><emphasis><filename>la:</filename></emphasis> 1666 <listitem><para><emphasis><filename>la:</filename></emphasis>
1637 Checks <filename>.la</filename> files for any <filename>TMPDIR</filename> 1667 Checks <filename>.la</filename> files for any <filename>TMPDIR</filename>
1638 paths. 1668 paths.
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index d180eee7bb..22c1e26eb9 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -300,7 +300,8 @@
300 recursive <filename>cp</filename> command, can preserve the 300 recursive <filename>cp</filename> command, can preserve the
301 UID and/or GID of the original file, which is usually not 301 UID and/or GID of the original file, which is usually not
302 what you want. 302 what you want.
303 The <filename>host-user-contaminated</filename> 303 The
304 <link linkend='ref-classes-insane'><filename>host-user-contaminated</filename></link>
304 QA check checks for files that probably have the wrong 305 QA check checks for files that probably have the wrong
305 ownership. 306 ownership.
306 </para> 307 </para>