diff options
author | Paul Eggleton <paul.eggleton@linux.intel.com> | 2013-04-09 10:56:43 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-13 23:57:14 +0100 |
commit | 0ffd01f835d8a0c568e888fe60db52ff8a45b087 (patch) | |
tree | 608e516f89cdcb80059eabee4f7d13cfd1052159 /documentation/ref-manual/ref-classes.xml | |
parent | 867abaa8fa464762a9f468a2a5f5f409f110f760 (diff) | |
download | ast2050-yocto-poky-0ffd01f835d8a0c568e888fe60db52ff8a45b087.zip ast2050-yocto-poky-0ffd01f835d8a0c568e888fe60db52ff8a45b087.tar.gz |
ref-manual/ref-classes: add missing QA checks
Added proper text formatting and cross-reference links to the
variables that exist in the reference glossary. Did a bit of
writing to shorten some long sentences and perform general
clean up.
Add the following missing QA checks to the section on insane.bbclass:
* textrel
* pkgvarcheck
* xorg-driver-abi
* libexec
* staticdev
(From yocto-docs rev: 2857cc20b3b136b17d1d2892e046b2ae7f4b699d)
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>
Diffstat (limited to 'documentation/ref-manual/ref-classes.xml')
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 8a69ae0..9f344a6 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -524,6 +524,54 @@ Any <filename>.pc</filename> file containing these paths is incorrect since <filename>pkg-config</filename> itself adds the correct sysroot prefix when the files are accessed.</para></listitem> + <listitem><para><emphasis><filename>textrel:</filename></emphasis> + Checks for ELF binaries that contain relocations in their + <filename>.text</filename> sections, which can result in a + performance impact at runtime.</para></listitem> + <listitem><para><emphasis><filename>pkgvarcheck:</filename></emphasis> + Checks through the variables + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, + <filename>RSUGGESTS</filename>, + <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>, + <filename>RPROVIDES</filename>, + <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, + <link linkend='var-FILES'><filename>FILES</filename></link>, + <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>, + <filename>pkg_preinst</filename>, + <filename>pkg_postinst</filename>, + <filename>pkg_prerm</filename> + and <filename>pkg_postrm</filename>, and reports if there are + variable sets that are not package-specific. + Using these variables without a package suffix is bad practice, + and might unecessarily complicate dependencies of other packages + within the same recipe or have other unintended consequences. + </para></listitem> + <listitem><para><emphasis><filename>xorg-driver-abi:</filename></emphasis> + Checks that all packages containing Xorg drivers have ABI + dependencies. + The <filename>xserver-xorg</filename> recipe provides driver + ABI names. + All drivers should depend on the ABI versions that they have + been built against. + Driver recipes that include + <filename>xorg-driver-input.inc</filename> + or <filename>xorg-driver-video.inc</filename> will + automatically get these versions. + Consequently, you should only need to explicitly add + dependencies to binary driver recipes. + </para></listitem> + <listitem><para><emphasis><filename>libexec:</filename></emphasis> + Checks if a package contains files in + <filename>/usr/libexec</filename>. + This check is not performed if the + <filename>libexecdir</filename> variable has been set + explicitly to <filename>/usr/libexec</filename>. + </para></listitem> + <listitem><para><emphasis><filename>staticdev:</filename></emphasis> + Checks for static library files (<filename>*.a</filename>) in + non-<filename>staticdev</filename> packages. + </para></listitem> <listitem><para><emphasis><filename>la:</filename></emphasis> Checks <filename>.la</filename> files for any <filename>TMPDIR</filename> paths. |