summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@linux.intel.com>2013-04-09 10:56:43 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-13 23:57:21 +0100
commit6938af111e2af2988cb203427e6cfb1b91227f1f (patch)
tree22e5c09b2d6402f73a96b8f238e5452fd5358f56 /documentation
parentc6a0d8642faf2e87bc42243f6f805f92549312ef (diff)
downloadpoky-6938af111e2af2988cb203427e6cfb1b91227f1f.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')
-rw-r--r--documentation/ref-manual/ref-classes.xml48
1 files changed, 48 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 8a69ae0b9e..9f344a63cd 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -524,6 +524,54 @@
524 Any <filename>.pc</filename> file containing these paths is incorrect 524 Any <filename>.pc</filename> file containing these paths is incorrect
525 since <filename>pkg-config</filename> itself adds the correct sysroot prefix 525 since <filename>pkg-config</filename> itself adds the correct sysroot prefix
526 when the files are accessed.</para></listitem> 526 when the files are accessed.</para></listitem>
527 <listitem><para><emphasis><filename>textrel:</filename></emphasis>
528 Checks for ELF binaries that contain relocations in their
529 <filename>.text</filename> sections, which can result in a
530 performance impact at runtime.</para></listitem>
531 <listitem><para><emphasis><filename>pkgvarcheck:</filename></emphasis>
532 Checks through the variables
533 <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>,
534 <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>,
535 <filename>RSUGGESTS</filename>,
536 <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>,
537 <filename>RPROVIDES</filename>,
538 <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>,
539 <link linkend='var-FILES'><filename>FILES</filename></link>,
540 <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>,
541 <filename>pkg_preinst</filename>,
542 <filename>pkg_postinst</filename>,
543 <filename>pkg_prerm</filename>
544 and <filename>pkg_postrm</filename>, and reports if there are
545 variable sets that are not package-specific.
546 Using these variables without a package suffix is bad practice,
547 and might unecessarily complicate dependencies of other packages
548 within the same recipe or have other unintended consequences.
549 </para></listitem>
550 <listitem><para><emphasis><filename>xorg-driver-abi:</filename></emphasis>
551 Checks that all packages containing Xorg drivers have ABI
552 dependencies.
553 The <filename>xserver-xorg</filename> recipe provides driver
554 ABI names.
555 All drivers should depend on the ABI versions that they have
556 been built against.
557 Driver recipes that include
558 <filename>xorg-driver-input.inc</filename>
559 or <filename>xorg-driver-video.inc</filename> will
560 automatically get these versions.
561 Consequently, you should only need to explicitly add
562 dependencies to binary driver recipes.
563 </para></listitem>
564 <listitem><para><emphasis><filename>libexec:</filename></emphasis>
565 Checks if a package contains files in
566 <filename>/usr/libexec</filename>.
567 This check is not performed if the
568 <filename>libexecdir</filename> variable has been set
569 explicitly to <filename>/usr/libexec</filename>.
570 </para></listitem>
571 <listitem><para><emphasis><filename>staticdev:</filename></emphasis>
572 Checks for static library files (<filename>*.a</filename>) in
573 non-<filename>staticdev</filename> packages.
574 </para></listitem>
527 <listitem><para><emphasis><filename>la:</filename></emphasis> 575 <listitem><para><emphasis><filename>la:</filename></emphasis>
528 Checks <filename>.la</filename> files for any <filename>TMPDIR</filename> 576 Checks <filename>.la</filename> files for any <filename>TMPDIR</filename>
529 paths. 577 paths.