summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/eclipse/html/poky-ref-manual/ref-classes-insane.html
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/eclipse/html/poky-ref-manual/ref-classes-insane.html')
-rw-r--r--documentation/ref-manual/eclipse/html/poky-ref-manual/ref-classes-insane.html105
1 files changed, 0 insertions, 105 deletions
diff --git a/documentation/ref-manual/eclipse/html/poky-ref-manual/ref-classes-insane.html b/documentation/ref-manual/eclipse/html/poky-ref-manual/ref-classes-insane.html
deleted file mode 100644
index 1cdf589cff..0000000000
--- a/documentation/ref-manual/eclipse/html/poky-ref-manual/ref-classes-insane.html
+++ /dev/null
@@ -1,105 +0,0 @@
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title>7.17. Generated output quality assurance checks - insane.bbclass</title>
5<link rel="stylesheet" type="text/css" href="../book.css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7<link rel="home" href="index.html" title="The Yocto Project Reference Manual">
8<link rel="up" href="ref-classes.html" title="Chapter 7. Classes">
9<link rel="prev" href="ref-classes-sanity.html" title="7.16. Host System sanity checks - sanity.bbclass">
10<link rel="next" href="ref-classes-siteinfo.html" title="7.18. Autotools configuration data cache - siteinfo.bbclass">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="section" title="7.17. Generated output quality assurance checks - insane.bbclass">
13<div class="titlepage"><div><div><h2 class="title" style="clear: both">
14<a name="ref-classes-insane"></a>7.17. Generated output quality assurance checks - <code class="filename">insane.bbclass</code>
15</h2></div></div></div>
16<p>
17 This class adds a step to the package generation process that sanity checks the
18 packages generated by the OpenEmbedded build system.
19 A range of checks are performed that check the build's output
20 for common problems that show up during runtime.
21 Distribution policy usually dictates whether to include this class.
22 </p>
23<p>
24 You can configure the sanity checks so that specific test failures either raise a warning or
25 an error message.
26 Typically, failures for new tests generate a warning.
27 Subsequent failures for the same test would then generate an error message
28 once the metadata is in a known and good condition.
29 You use the <code class="filename">WARN_QA</code> variable to specify tests for which you
30 want to generate a warning message on failure.
31 You use the <code class="filename">ERROR_QA</code> variable to specify tests for which you
32 want to generate an error message on failure.
33 </p>
34<p>
35 The following list shows the tests you can list with the <code class="filename">WARN_QA</code>
36 and <code class="filename">ERROR_QA</code> variables:
37 </p>
38<div class="itemizedlist"><ul class="itemizedlist" type="disc">
39<li class="listitem"><p><span class="emphasis"><em><code class="filename">ldflags:</code></em></span>
40 Ensures that the binaries were linked with the
41 <code class="filename">LDFLAGS</code> options provided by the build system.
42 If this test fails, check that the <code class="filename">LDFLAGS</code> variable
43 is being passed to the linker command.</p></li>
44<li class="listitem"><p><span class="emphasis"><em><code class="filename">useless-rpaths:</code></em></span>
45 Checks for dynamic library load paths (rpaths) in the binaries that
46 by default on a standard system are searched by the linker (e.g.
47 <code class="filename">/lib</code> and <code class="filename">/usr/lib</code>).
48 While these paths will not cause any breakage, they do waste space and
49 are unnecessary.</p></li>
50<li class="listitem"><p><span class="emphasis"><em><code class="filename">rpaths:</code></em></span>
51 Checks for rpaths in the binaries that contain build system paths such
52 as <code class="filename">TMPDIR</code>.
53 If this test fails, bad <code class="filename">-rpath</code> options are being
54 passed to the linker commands and your binaries have potential security
55 issues.</p></li>
56<li class="listitem"><p><span class="emphasis"><em><code class="filename">dev-so:</code></em></span>
57 Checks that the <code class="filename">.so</code> symbolic links are in the
58 <code class="filename">-dev</code> package and not in any of the other packages.
59 In general, these symlinks are only useful for development purposes.
60 Thus, the <code class="filename">-dev</code> package is the correct location for
61 them.
62 Some very rare cases do exist for dynamically loaded modules where
63 these symlinks are needed instead in the main package.
64 </p></li>
65<li class="listitem"><p><span class="emphasis"><em><code class="filename">debug-files:</code></em></span>
66 Checks for <code class="filename">.debug</code> directories in anything but the
67 <code class="filename">-dbg</code> package.
68 The debug files should all be in the <code class="filename">-dbg</code> package.
69 Thus, anything packaged elsewhere is incorrect packaging.</p></li>
70<li class="listitem"><p><span class="emphasis"><em><code class="filename">arch:</code></em></span>
71 Checks the Executable and Linkable Format (ELF) type, bit size and endianness
72 of any binaries to ensure it matches the target architecture.
73 This test fails if any binaries don't match the type since there would be an
74 incompatibility.
75 Sometimes software, like bootloaders, might need to bypass this check.
76 </p></li>
77<li class="listitem"><p><span class="emphasis"><em><code class="filename">debug-deps:</code></em></span>
78 Checks that <code class="filename">-dbg</code> packages only depend on other
79 <code class="filename">-dbg</code> packages and not on any other types of packages,
80 which would cause a packaging bug.</p></li>
81<li class="listitem"><p><span class="emphasis"><em><code class="filename">dev-deps:</code></em></span>
82 Checks that <code class="filename">-dev</code> packages only depend on other
83 <code class="filename">-dev</code> packages and not on any other types of packages,
84 which would be a packaging bug.</p></li>
85<li class="listitem"><p><span class="emphasis"><em><code class="filename">pkgconfig:</code></em></span>
86 Checks <code class="filename">.pc</code> files for any
87 <code class="filename">TMPDIR/WORKDIR</code> paths.
88 Any <code class="filename">.pc</code> file containing these paths is incorrect
89 since <code class="filename">pkg-config</code> itself adds the correct sysroot prefix
90 when the files are accessed.</p></li>
91<li class="listitem"><p><span class="emphasis"><em><code class="filename">la:</code></em></span>
92 Checks <code class="filename">.la</code> files for any <code class="filename">TMPDIR</code>
93 paths.
94 Any <code class="filename">.la</code> file continaing these paths is incorrect since
95 <code class="filename">libtool</code> adds the correct sysroot prefix when using the
96 files automatically itself.</p></li>
97<li class="listitem"><p><span class="emphasis"><em><code class="filename">desktop:</code></em></span>
98 Runs the <code class="filename">desktop-file-validate</code> program against any
99 <code class="filename">.desktop</code> files to validate their contents against
100 the specification for <code class="filename">.desktop</code> files.</p></li>
101</ul></div>
102<p>
103 </p>
104</div></body>
105</html>