diff options
Diffstat (limited to 'documentation/ref-manual/ref-qa-checks.xml')
-rw-r--r-- | documentation/ref-manual/ref-qa-checks.xml | 83 |
1 files changed, 43 insertions, 40 deletions
diff --git a/documentation/ref-manual/ref-qa-checks.xml b/documentation/ref-manual/ref-qa-checks.xml index 15c1bbe4f5..3f4e7d8fa1 100644 --- a/documentation/ref-manual/ref-qa-checks.xml +++ b/documentation/ref-manual/ref-qa-checks.xml | |||
@@ -59,10 +59,21 @@ | |||
59 | <section id='qa-errors-and-warnings'> | 59 | <section id='qa-errors-and-warnings'> |
60 | <title>Errors and Warnings</title> | 60 | <title>Errors and Warnings</title> |
61 | 61 | ||
62 | <!-- | ||
63 | This section uses the <para><code> construct to enable permalinks for the | ||
64 | various QA issue and warning messages. The file templates/qa-code-permalinks.xsl | ||
65 | is used to locate the construct and generate the permalink. This solution | ||
66 | leverages the fact that right now this section in the ref-manual is the only | ||
67 | place is all the YP docs that uses the <para><code> construct. If, in the | ||
68 | future, that construct were to appear in the ref-manual, a generic permalink | ||
69 | would be generated for the text between <code></code>. If a better solution | ||
70 | can be found then it should be implemented. I can't find one at the moment. | ||
71 | --> | ||
72 | |||
62 | <para> | 73 | <para> |
63 | <itemizedlist> | 74 | <itemizedlist> |
64 | <listitem> | 75 | <listitem> |
65 | <para> | 76 | <para id='qa-issue-libexec'> |
66 | <code> | 77 | <code> |
67 | <packagename>: <path> is using libexec please relocate to <libexecdir> [libexec] | 78 | <packagename>: <path> is using libexec please relocate to <libexecdir> [libexec] |
68 | </code> | 79 | </code> |
@@ -87,7 +98,7 @@ | |||
87 | <para> | 98 | <para> |
88 | <itemizedlist> | 99 | <itemizedlist> |
89 | <listitem> | 100 | <listitem> |
90 | <para> | 101 | <para id='qa-issue-rpaths'> |
91 | <code> | 102 | <code> |
92 | package <packagename> contains bad RPATH <rpath> in file <file> [rpaths] | 103 | package <packagename> contains bad RPATH <rpath> in file <file> [rpaths] |
93 | </code> | 104 | </code> |
@@ -119,7 +130,7 @@ | |||
119 | <para> | 130 | <para> |
120 | <itemizedlist> | 131 | <itemizedlist> |
121 | <listitem> | 132 | <listitem> |
122 | <para> | 133 | <para id='qa-issue-useless-rpaths'> |
123 | <code> | 134 | <code> |
124 | <packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths] | 135 | <packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths] |
125 | </code> | 136 | </code> |
@@ -147,7 +158,7 @@ | |||
147 | <para> | 158 | <para> |
148 | <itemizedlist> | 159 | <itemizedlist> |
149 | <listitem> | 160 | <listitem> |
150 | <para> | 161 | <para id='qa-issue-dev-so'> |
151 | <code> | 162 | <code> |
152 | non -dev/-dbg/-nativesdk package contains symlink .so: <packagename> path '<path>' [dev-so] | 163 | non -dev/-dbg/-nativesdk package contains symlink .so: <packagename> path '<path>' [dev-so] |
153 | </code> | 164 | </code> |
@@ -178,7 +189,7 @@ | |||
178 | <para> | 189 | <para> |
179 | <itemizedlist> | 190 | <itemizedlist> |
180 | <listitem> | 191 | <listitem> |
181 | <para> | 192 | <para id='qa-issue-staticdev'> |
182 | <code> | 193 | <code> |
183 | non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev] | 194 | non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev] |
184 | </code> | 195 | </code> |
@@ -205,7 +216,7 @@ | |||
205 | <para> | 216 | <para> |
206 | <itemizedlist> | 217 | <itemizedlist> |
207 | <listitem> | 218 | <listitem> |
208 | <para> | 219 | <para id='qa-issue-libdir'> |
209 | <code> | 220 | <code> |
210 | <packagename>: found library in wrong location [libdir] | 221 | <packagename>: found library in wrong location [libdir] |
211 | </code> | 222 | </code> |
@@ -236,7 +247,7 @@ | |||
236 | <para> | 247 | <para> |
237 | <itemizedlist> | 248 | <itemizedlist> |
238 | <listitem> | 249 | <listitem> |
239 | <para> | 250 | <para id='qa-issue-debug-files'> |
240 | <code> | 251 | <code> |
241 | non debug package contains .debug directory: <packagename> path <path> [debug-files] | 252 | non debug package contains .debug directory: <packagename> path <path> [debug-files] |
242 | </code> | 253 | </code> |
@@ -269,7 +280,7 @@ | |||
269 | <para> | 280 | <para> |
270 | <itemizedlist> | 281 | <itemizedlist> |
271 | <listitem> | 282 | <listitem> |
272 | <para> | 283 | <para id='qa-issue-arch'> |
273 | <code> | 284 | <code> |
274 | Architecture did not match (<machine_arch> to <file_arch>) on <file> [arch] | 285 | Architecture did not match (<machine_arch> to <file_arch>) on <file> [arch] |
275 | </code> | 286 | </code> |
@@ -308,7 +319,7 @@ | |||
308 | <para> | 319 | <para> |
309 | <itemizedlist> | 320 | <itemizedlist> |
310 | <listitem> | 321 | <listitem> |
311 | <para> | 322 | <para id='qa-issue-arch-bit-size-no-match'> |
312 | <code> | 323 | <code> |
313 | Bit size did not match (<machine_bits> to <file_bits>) <recipe> on <file> [arch] | 324 | Bit size did not match (<machine_bits> to <file_bits>) <recipe> on <file> [arch] |
314 | </code> | 325 | </code> |
@@ -347,7 +358,7 @@ | |||
347 | <para> | 358 | <para> |
348 | <itemizedlist> | 359 | <itemizedlist> |
349 | <listitem> | 360 | <listitem> |
350 | <para> | 361 | <para id='qa-issue-arch-endianness-no-match'> |
351 | <code> | 362 | <code> |
352 | Endianness did not match (<machine_endianness> to <file_endianness>) on <file> [arch] | 363 | Endianness did not match (<machine_endianness> to <file_endianness>) on <file> [arch] |
353 | </code> | 364 | </code> |
@@ -386,7 +397,7 @@ | |||
386 | <para> | 397 | <para> |
387 | <itemizedlist> | 398 | <itemizedlist> |
388 | <listitem> | 399 | <listitem> |
389 | <para> | 400 | <para id='qa-issue-textrel'> |
390 | <code> | 401 | <code> |
391 | ELF binary '<file>' has relocations in .text [textrel] | 402 | ELF binary '<file>' has relocations in .text [textrel] |
392 | </code> | 403 | </code> |
@@ -397,13 +408,6 @@ | |||
397 | <filename>.text</filename> sections. | 408 | <filename>.text</filename> sections. |
398 | This situation can result in a performance impact | 409 | This situation can result in a performance impact |
399 | at runtime. | 410 | at runtime. |
400 | <note> | ||
401 | A bug currently exists that causes this | ||
402 | warning to appear erroneously. | ||
403 | See | ||
404 | <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=6104'></ulink> | ||
405 | for more information. | ||
406 | </note> | ||
407 | </para> | 411 | </para> |
408 | 412 | ||
409 | <para> | 413 | <para> |
@@ -416,7 +420,7 @@ | |||
416 | <para> | 420 | <para> |
417 | <itemizedlist> | 421 | <itemizedlist> |
418 | <listitem> | 422 | <listitem> |
419 | <para> | 423 | <para id='qa-issue-ldflags'> |
420 | <code> | 424 | <code> |
421 | No GNU_HASH in the elf binary: '<file>' [ldflags] | 425 | No GNU_HASH in the elf binary: '<file>' [ldflags] |
422 | </code> | 426 | </code> |
@@ -448,7 +452,7 @@ | |||
448 | <para> | 452 | <para> |
449 | <itemizedlist> | 453 | <itemizedlist> |
450 | <listitem> | 454 | <listitem> |
451 | <para> | 455 | <para id='qa-issue-xorg-driver-abi'> |
452 | <code> | 456 | <code> |
453 | Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi] | 457 | Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi] |
454 | </code> | 458 | </code> |
@@ -478,7 +482,7 @@ | |||
478 | <para> | 482 | <para> |
479 | <itemizedlist> | 483 | <itemizedlist> |
480 | <listitem> | 484 | <listitem> |
481 | <para> | 485 | <para id='qa-issue-infodir'> |
482 | <code> | 486 | <code> |
483 | The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir] | 487 | The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir] |
484 | </code> | 488 | </code> |
@@ -506,7 +510,7 @@ | |||
506 | <para> | 510 | <para> |
507 | <itemizedlist> | 511 | <itemizedlist> |
508 | <listitem> | 512 | <listitem> |
509 | <para> | 513 | <para id='qa-issue-symlink-to-sysroot'> |
510 | <code> | 514 | <code> |
511 | Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot] | 515 | Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot] |
512 | </code> | 516 | </code> |
@@ -533,7 +537,7 @@ | |||
533 | <para> | 537 | <para> |
534 | <itemizedlist> | 538 | <itemizedlist> |
535 | <listitem> | 539 | <listitem> |
536 | <para> | 540 | <para id='qa-issue-la'> |
537 | <code> | 541 | <code> |
538 | <file> failed sanity test (workdir) in path <path> [la] | 542 | <file> failed sanity test (workdir) in path <path> [la] |
539 | </code> | 543 | </code> |
@@ -559,7 +563,7 @@ | |||
559 | <para> | 563 | <para> |
560 | <itemizedlist> | 564 | <itemizedlist> |
561 | <listitem> | 565 | <listitem> |
562 | <para> | 566 | <para id='qa-issue-pkgconfig'> |
563 | <code> | 567 | <code> |
564 | <file> failed sanity test (tmpdir) in path <path> [pkgconfig] | 568 | <file> failed sanity test (tmpdir) in path <path> [pkgconfig] |
565 | </code> | 569 | </code> |
@@ -584,7 +588,7 @@ | |||
584 | <para> | 588 | <para> |
585 | <itemizedlist> | 589 | <itemizedlist> |
586 | <listitem> | 590 | <listitem> |
587 | <para> | 591 | <para id='qa-issue-debug-deps'> |
588 | <code> | 592 | <code> |
589 | <packagename> rdepends on <debug_packagename> [debug-deps] | 593 | <packagename> rdepends on <debug_packagename> [debug-deps] |
590 | </code> | 594 | </code> |
@@ -632,7 +636,7 @@ | |||
632 | <para> | 636 | <para> |
633 | <itemizedlist> | 637 | <itemizedlist> |
634 | <listitem> | 638 | <listitem> |
635 | <para> | 639 | <para id='qa-issue-dev-deps'> |
636 | <code> | 640 | <code> |
637 | <packagename> rdepends on <dev_packagename> [dev-deps] | 641 | <packagename> rdepends on <dev_packagename> [dev-deps] |
638 | </code> | 642 | </code> |
@@ -680,7 +684,7 @@ | |||
680 | <para> | 684 | <para> |
681 | <itemizedlist> | 685 | <itemizedlist> |
682 | <listitem> | 686 | <listitem> |
683 | <para> | 687 | <para id='qa-issue-dep-cmp'> |
684 | <code> | 688 | <code> |
685 | <var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp] | 689 | <var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp] |
686 | </code> | 690 | </code> |
@@ -711,7 +715,7 @@ | |||
711 | <para> | 715 | <para> |
712 | <itemizedlist> | 716 | <itemizedlist> |
713 | <listitem> | 717 | <listitem> |
714 | <para> | 718 | <para id='qa-issue-compile-host-path'> |
715 | <code> | 719 | <code> |
716 | <recipename>: The compile log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [compile-host-path] | 720 | <recipename>: The compile log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [compile-host-path] |
717 | </code> | 721 | </code> |
@@ -736,7 +740,7 @@ | |||
736 | <para> | 740 | <para> |
737 | <itemizedlist> | 741 | <itemizedlist> |
738 | <listitem> | 742 | <listitem> |
739 | <para> | 743 | <para id='qa-issue-install-host-path'> |
740 | <code> | 744 | <code> |
741 | <recipename>: The install log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [install-host-path] | 745 | <recipename>: The install log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [install-host-path] |
742 | </code> | 746 | </code> |
@@ -761,7 +765,7 @@ | |||
761 | <para> | 765 | <para> |
762 | <itemizedlist> | 766 | <itemizedlist> |
763 | <listitem> | 767 | <listitem> |
764 | <para> | 768 | <para id='qa-issue-autoconf-log'> |
765 | <code> | 769 | <code> |
766 | This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. The path was '<path>' | 770 | This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. The path was '<path>' |
767 | </code> | 771 | </code> |
@@ -786,7 +790,7 @@ | |||
786 | <para> | 790 | <para> |
787 | <itemizedlist> | 791 | <itemizedlist> |
788 | <listitem> | 792 | <listitem> |
789 | <para> | 793 | <para id='qa-issue-pkgname'> |
790 | <code> | 794 | <code> |
791 | <packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname] | 795 | <packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname] |
792 | </code> | 796 | </code> |
@@ -818,7 +822,7 @@ | |||
818 | <para> | 822 | <para> |
819 | <itemizedlist> | 823 | <itemizedlist> |
820 | <listitem> | 824 | <listitem> |
821 | <para> | 825 | <para id='qa-issue-unknown-configure-option'> |
822 | <code> | 826 | <code> |
823 | <recipe>: configure was passed unrecognized options: <options> [unknown-configure-option] | 827 | <recipe>: configure was passed unrecognized options: <options> [unknown-configure-option] |
824 | </code> | 828 | </code> |
@@ -854,7 +858,7 @@ | |||
854 | <para> | 858 | <para> |
855 | <itemizedlist> | 859 | <itemizedlist> |
856 | <listitem> | 860 | <listitem> |
857 | <para> | 861 | <para id='qa-issue-pn-overrides'> |
858 | <code> | 862 | <code> |
859 | Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides] | 863 | Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides] |
860 | </code> | 864 | </code> |
@@ -894,7 +898,7 @@ | |||
894 | <para> | 898 | <para> |
895 | <itemizedlist> | 899 | <itemizedlist> |
896 | <listitem> | 900 | <listitem> |
897 | <para> | 901 | <para id='qa-issue-pkgvarcheck'> |
898 | <code> | 902 | <code> |
899 | <recipefile>: Variable <variable> is set as not being package specific, please fix this. [pkgvarcheck] | 903 | <recipefile>: Variable <variable> is set as not being package specific, please fix this. [pkgvarcheck] |
900 | </code> | 904 | </code> |
@@ -932,7 +936,7 @@ | |||
932 | <para> | 936 | <para> |
933 | <itemizedlist> | 937 | <itemizedlist> |
934 | <listitem> | 938 | <listitem> |
935 | <para> | 939 | <para id='qa-issue-already-stripped'> |
936 | <code> | 940 | <code> |
937 | File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped] | 941 | File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped] |
938 | </code> | 942 | </code> |
@@ -977,7 +981,7 @@ | |||
977 | <para> | 981 | <para> |
978 | <itemizedlist> | 982 | <itemizedlist> |
979 | <listitem> | 983 | <listitem> |
980 | <para> | 984 | <para id='qa-issue-packages-list'> |
981 | <code> | 985 | <code> |
982 | <packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list] | 986 | <packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list] |
983 | </code> | 987 | </code> |
@@ -1002,7 +1006,7 @@ | |||
1002 | <para> | 1006 | <para> |
1003 | <itemizedlist> | 1007 | <itemizedlist> |
1004 | <listitem> | 1008 | <listitem> |
1005 | <para> | 1009 | <para id='qa-issue-files-invalid'> |
1006 | <code> | 1010 | <code> |
1007 | FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid] | 1011 | FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid] |
1008 | </code> | 1012 | </code> |
@@ -1025,7 +1029,7 @@ | |||
1025 | <para> | 1029 | <para> |
1026 | <itemizedlist> | 1030 | <itemizedlist> |
1027 | <listitem> | 1031 | <listitem> |
1028 | <para> | 1032 | <para id='qa-issue-installed-vs-shipped'> |
1029 | <code> | 1033 | <code> |
1030 | <recipename>: Files/directories were installed but not shipped [installed-vs-shipped] | 1034 | <recipename>: Files/directories were installed but not shipped [installed-vs-shipped] |
1031 | </code> | 1035 | </code> |
@@ -1065,7 +1069,7 @@ | |||
1065 | <para> | 1069 | <para> |
1066 | <itemizedlist> | 1070 | <itemizedlist> |
1067 | <listitem> | 1071 | <listitem> |
1068 | <para> | 1072 | <para id='qa-issue-old-and-new-package-and-version-names'> |
1069 | <code> | 1073 | <code> |
1070 | <oldpackage>-<oldpkgversion> was registered as shlib provider for <library>, changing it to <newpackage>-<newpkgversion> because it was built later | 1074 | <oldpackage>-<oldpkgversion> was registered as shlib provider for <library>, changing it to <newpackage>-<newpkgversion> because it was built later |
1071 | </code> | 1075 | </code> |
@@ -1151,7 +1155,6 @@ enabled by default: | |||
1151 | </note> | 1155 | </note> |
1152 | </para> | 1156 | </para> |
1153 | </section> | 1157 | </section> |
1154 | |||
1155 | </chapter> | 1158 | </chapter> |
1156 | <!-- | 1159 | <!-- |
1157 | vim: expandtab tw=80 ts=4 | 1160 | vim: expandtab tw=80 ts=4 |