diff options
author | Paul Eggleton <paul.eggleton@microsoft.com> | 2020-10-27 18:18:29 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-10-30 12:09:21 +0000 |
commit | 266e1d6ae83e3a7b1ba75f6360e744dab1ad2d10 (patch) | |
tree | ff31cfb0fbc3c2cf83e06a2d1bf262b89bca0b1e | |
parent | 7231c104303f72c5d72f837de114d4f5a633c7cd (diff) | |
download | poky-266e1d6ae83e3a7b1ba75f6360e744dab1ad2d10.tar.gz |
ref-manual: add reference anchors for each QA check
Make it possible to link to the explanation for a particular QA check.
(From yocto-docs rev: 3f6dc24e0a371feca8fe66c1be8c86e599307854)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/ref-manual/ref-qa-checks.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-qa-checks.rst b/documentation/ref-manual/ref-qa-checks.rst index 5b9f92d35e..228b4fd538 100644 --- a/documentation/ref-manual/ref-qa-checks.rst +++ b/documentation/ref-manual/ref-qa-checks.rst | |||
@@ -43,6 +43,8 @@ error form along with an explanation. | |||
43 | Errors and Warnings | 43 | Errors and Warnings |
44 | =================== | 44 | =================== |
45 | 45 | ||
46 | .. _qa-check-libexec: | ||
47 | |||
46 | - ``<packagename>: <path> is using libexec please relocate to <libexecdir> [libexec]`` | 48 | - ``<packagename>: <path> is using libexec please relocate to <libexecdir> [libexec]`` |
47 | 49 | ||
48 | The specified package contains files in ``/usr/libexec`` when the | 50 | The specified package contains files in ``/usr/libexec`` when the |
@@ -51,6 +53,7 @@ Errors and Warnings | |||
51 | default can be changed (e.g. ``${libdir}``). | 53 | default can be changed (e.g. ``${libdir}``). |
52 | 54 | ||
53 | 55 | ||
56 | .. _qa-check-rpaths: | ||
54 | 57 | ||
55 | - ``package <packagename> contains bad RPATH <rpath> in file <file> [rpaths]`` | 58 | - ``package <packagename> contains bad RPATH <rpath> in file <file> [rpaths]`` |
56 | 59 | ||
@@ -65,6 +68,7 @@ Errors and Warnings | |||
65 | software. | 68 | software. |
66 | 69 | ||
67 | 70 | ||
71 | .. _qa-check-useless-rpaths: | ||
68 | 72 | ||
69 | - ``<packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths]`` | 73 | - ``<packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths]`` |
70 | 74 | ||
@@ -77,6 +81,7 @@ Errors and Warnings | |||
77 | the build of the software. | 81 | the build of the software. |
78 | 82 | ||
79 | 83 | ||
84 | .. _qa-check-file-rdeps: | ||
80 | 85 | ||
81 | - ``<packagename> requires <files>, but no providers in its RDEPENDS [file-rdeps]`` | 86 | - ``<packagename> requires <files>, but no providers in its RDEPENDS [file-rdeps]`` |
82 | 87 | ||
@@ -88,6 +93,7 @@ Errors and Warnings | |||
88 | built. | 93 | built. |
89 | 94 | ||
90 | 95 | ||
96 | .. _qa-check-build-deps: | ||
91 | 97 | ||
92 | - ``<packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps]`` | 98 | - ``<packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps]`` |
93 | 99 | ||
@@ -101,6 +107,7 @@ Errors and Warnings | |||
101 | to add an explicit ``RDEPENDS`` for the dependency. | 107 | to add an explicit ``RDEPENDS`` for the dependency. |
102 | 108 | ||
103 | 109 | ||
110 | .. _qa-check-dev-so: | ||
104 | 111 | ||
105 | - ``non -dev/-dbg/nativesdk- package contains symlink .so: <packagename> path '<path>' [dev-so]`` | 112 | - ``non -dev/-dbg/nativesdk- package contains symlink .so: <packagename> path '<path>' [dev-so]`` |
106 | 113 | ||
@@ -112,6 +119,7 @@ Errors and Warnings | |||
112 | file goes into an appropriate ``-dev`` package. | 119 | file goes into an appropriate ``-dev`` package. |
113 | 120 | ||
114 | 121 | ||
122 | .. _qa-check-staticdev: | ||
115 | 123 | ||
116 | - ``non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev]`` | 124 | - ``non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev]`` |
117 | 125 | ||
@@ -121,6 +129,7 @@ Errors and Warnings | |||
121 | goes into an appropriate ``-staticdev`` package. | 129 | goes into an appropriate ``-staticdev`` package. |
122 | 130 | ||
123 | 131 | ||
132 | .. _qa-check-libdir: | ||
124 | 133 | ||
125 | - ``<packagename>: found library in wrong location [libdir]`` | 134 | - ``<packagename>: found library in wrong location [libdir]`` |
126 | 135 | ||
@@ -133,6 +142,7 @@ Errors and Warnings | |||
133 | :term:`INSANE_SKIP` for the package. | 142 | :term:`INSANE_SKIP` for the package. |
134 | 143 | ||
135 | 144 | ||
145 | .. _qa-check-debug-files: | ||
136 | 146 | ||
137 | - ``non debug package contains .debug directory: <packagename> path <path> [debug-files]`` | 147 | - ``non debug package contains .debug directory: <packagename> path <path> [debug-files]`` |
138 | 148 | ||
@@ -145,6 +155,7 @@ Errors and Warnings | |||
145 | information on ``FILES``. | 155 | information on ``FILES``. |
146 | 156 | ||
147 | 157 | ||
158 | .. _qa-check-arch: | ||
148 | 159 | ||
149 | - ``Architecture did not match (<machine_arch> to <file_arch>) on <file> [arch]`` | 160 | - ``Architecture did not match (<machine_arch> to <file_arch>) on <file> [arch]`` |
150 | 161 | ||
@@ -199,6 +210,7 @@ Errors and Warnings | |||
199 | and verify that the compiler options being used are correct. | 210 | and verify that the compiler options being used are correct. |
200 | 211 | ||
201 | 212 | ||
213 | .. _qa-check-textrel: | ||
202 | 214 | ||
203 | - ``ELF binary '<file>' has relocations in .text [textrel]`` | 215 | - ``ELF binary '<file>' has relocations in .text [textrel]`` |
204 | 216 | ||
@@ -218,6 +230,7 @@ Errors and Warnings | |||
218 | http://www.akkadia.org/drepper/textrelocs.html. | 230 | http://www.akkadia.org/drepper/textrelocs.html. |
219 | 231 | ||
220 | 232 | ||
233 | .. _qa-check-ldflags: | ||
221 | 234 | ||
222 | - ``No GNU_HASH in the elf binary: '<file>' [ldflags]`` | 235 | - ``No GNU_HASH in the elf binary: '<file>' [ldflags]`` |
223 | 236 | ||
@@ -233,6 +246,7 @@ Errors and Warnings | |||
233 | TARGET_CC_ARCH += "${LDFLAGS}" | 246 | TARGET_CC_ARCH += "${LDFLAGS}" |
234 | 247 | ||
235 | 248 | ||
249 | .. _qa-check-xorg-driver-abi: | ||
236 | 250 | ||
237 | - ``Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi]`` | 251 | - ``Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi]`` |
238 | 252 | ||
@@ -245,6 +259,7 @@ Errors and Warnings | |||
245 | to explicitly add dependencies to binary driver recipes. | 259 | to explicitly add dependencies to binary driver recipes. |
246 | 260 | ||
247 | 261 | ||
262 | .. _qa-check-infodir: | ||
248 | 263 | ||
249 | - ``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]`` | 264 | - ``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]`` |
250 | 265 | ||
@@ -256,6 +271,8 @@ Errors and Warnings | |||
256 | rm ${D}${infodir}/dir | 271 | rm ${D}${infodir}/dir |
257 | 272 | ||
258 | 273 | ||
274 | .. _qa-check-symlink-to-sysroot: | ||
275 | |||
259 | - ``Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot]`` | 276 | - ``Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot]`` |
260 | 277 | ||
261 | The specified symlink points into :term:`TMPDIR` on the | 278 | The specified symlink points into :term:`TMPDIR` on the |
@@ -264,6 +281,7 @@ Errors and Warnings | |||
264 | symlink to use a relative path or remove the symlink. | 281 | symlink to use a relative path or remove the symlink. |
265 | 282 | ||
266 | 283 | ||
284 | .. _qa-check-la: | ||
267 | 285 | ||
268 | - ``<file> failed sanity test (workdir) in path <path> [la]`` | 286 | - ``<file> failed sanity test (workdir) in path <path> [la]`` |
269 | 287 | ||
@@ -273,6 +291,7 @@ Errors and Warnings | |||
273 | automatically itself. | 291 | automatically itself. |
274 | 292 | ||
275 | 293 | ||
294 | .. _qa-check-pkgconfig: | ||
276 | 295 | ||
277 | - ``<file> failed sanity test (tmpdir) in path <path> [pkgconfig]`` | 296 | - ``<file> failed sanity test (tmpdir) in path <path> [pkgconfig]`` |
278 | 297 | ||
@@ -283,6 +302,7 @@ Errors and Warnings | |||
283 | are accessed. | 302 | are accessed. |
284 | 303 | ||
285 | 304 | ||
305 | .. _qa-check-debug-deps: | ||
286 | 306 | ||
287 | - ``<packagename> rdepends on <debug_packagename> [debug-deps]`` | 307 | - ``<packagename> rdepends on <debug_packagename> [debug-deps]`` |
288 | 308 | ||
@@ -305,6 +325,7 @@ Errors and Warnings | |||
305 | manually (e.g. by adding to :term:`RDEPENDS`). | 325 | manually (e.g. by adding to :term:`RDEPENDS`). |
306 | 326 | ||
307 | 327 | ||
328 | .. _qa-check-dev-deps: | ||
308 | 329 | ||
309 | - ``<packagename> rdepends on <dev_packagename> [dev-deps]`` | 330 | - ``<packagename> rdepends on <dev_packagename> [dev-deps]`` |
310 | 331 | ||
@@ -327,6 +348,7 @@ Errors and Warnings | |||
327 | manually (e.g. by adding to :term:`RDEPENDS`). | 348 | manually (e.g. by adding to :term:`RDEPENDS`). |
328 | 349 | ||
329 | 350 | ||
351 | .. _qa-check-dep-cmp: | ||
330 | 352 | ||
331 | - ``<var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp]`` | 353 | - ``<var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp]`` |
332 | 354 | ||
@@ -341,6 +363,7 @@ Errors and Warnings | |||
341 | adding to match those listed in the message. | 363 | adding to match those listed in the message. |
342 | 364 | ||
343 | 365 | ||
366 | .. _qa-check-compile-host-path: | ||
344 | 367 | ||
345 | - ``<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]`` | 368 | - ``<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]`` |
346 | 369 | ||
@@ -351,6 +374,7 @@ Errors and Warnings | |||
351 | file. | 374 | file. |
352 | 375 | ||
353 | 376 | ||
377 | .. _qa-check-install-host-path: | ||
354 | 378 | ||
355 | - ``<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]`` | 379 | - ``<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]`` |
356 | 380 | ||
@@ -361,6 +385,7 @@ Errors and Warnings | |||
361 | file. | 385 | file. |
362 | 386 | ||
363 | 387 | ||
388 | .. _qa-check-configure-unsafe: | ||
364 | 389 | ||
365 | - ``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>'`` | 390 | - ``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>'`` |
366 | 391 | ||
@@ -371,6 +396,7 @@ Errors and Warnings | |||
371 | file. | 396 | file. |
372 | 397 | ||
373 | 398 | ||
399 | .. _qa-check-pkgname: | ||
374 | 400 | ||
375 | - ``<packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname]`` | 401 | - ``<packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname]`` |
376 | 402 | ||
@@ -384,6 +410,7 @@ Errors and Warnings | |||
384 | change the package name appropriately. | 410 | change the package name appropriately. |
385 | 411 | ||
386 | 412 | ||
413 | .. _qa-check-unknown-configure-option: | ||
387 | 414 | ||
388 | - ``<recipe>: configure was passed unrecognized options: <options> [unknown-configure-option]`` | 415 | - ``<recipe>: configure was passed unrecognized options: <options> [unknown-configure-option]`` |
389 | 416 | ||
@@ -401,6 +428,7 @@ Errors and Warnings | |||
401 | accordingly. | 428 | accordingly. |
402 | 429 | ||
403 | 430 | ||
431 | .. _qa-check-pn-overrides: | ||
404 | 432 | ||
405 | - ``Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]`` | 433 | - ``Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]`` |
406 | 434 | ||
@@ -416,6 +444,7 @@ Errors and Warnings | |||
416 | :term:`FILES` for additional information. | 444 | :term:`FILES` for additional information. |
417 | 445 | ||
418 | 446 | ||
447 | .. _qa-check-pkgvarcheck: | ||
419 | 448 | ||
420 | - ``<recipefile>: Variable <variable> is set as not being package specific, please fix this. [pkgvarcheck]`` | 449 | - ``<recipefile>: Variable <variable> is set as not being package specific, please fix this. [pkgvarcheck]`` |
421 | 450 | ||
@@ -433,6 +462,7 @@ Errors and Warnings | |||
433 | assignments to these variables within your recipe. | 462 | assignments to these variables within your recipe. |
434 | 463 | ||
435 | 464 | ||
465 | .. _qa-check-already-stripped: | ||
436 | 466 | ||
437 | - ``File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped]`` | 467 | - ``File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped]`` |
438 | 468 | ||
@@ -458,6 +488,7 @@ Errors and Warnings | |||
458 | strip the symbols from the binaries. | 488 | strip the symbols from the binaries. |
459 | 489 | ||
460 | 490 | ||
491 | .. _qa-check-packages-list: | ||
461 | 492 | ||
462 | - ``<packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]`` | 493 | - ``<packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]`` |
463 | 494 | ||
@@ -467,6 +498,7 @@ Errors and Warnings | |||
467 | already in the variable's value. | 498 | already in the variable's value. |
468 | 499 | ||
469 | 500 | ||
501 | .. _qa-check-files-invalid: | ||
470 | 502 | ||
471 | - ``FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]`` | 503 | - ``FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]`` |
472 | 504 | ||
@@ -475,6 +507,7 @@ Errors and Warnings | |||
475 | that there is only a single "/". | 507 | that there is only a single "/". |
476 | 508 | ||
477 | 509 | ||
510 | .. _qa-check-installed-vs-shipped: | ||
478 | 511 | ||
479 | - ``<recipename>: Files/directories were installed but not shipped in any package [installed-vs-shipped]`` | 512 | - ``<recipename>: Files/directories were installed but not shipped in any package [installed-vs-shipped]`` |
480 | 513 | ||
@@ -505,6 +538,9 @@ Errors and Warnings | |||
505 | :term:`PRIVATE_LIBS` in the recipe that provides | 538 | :term:`PRIVATE_LIBS` in the recipe that provides |
506 | the private version of the library. | 539 | the private version of the library. |
507 | 540 | ||
541 | |||
542 | .. _qa-check-unlisted-pkg-lics: | ||
543 | |||
508 | - ``LICENSE_<packagename> includes licenses (<licenses>) that are not listed in LICENSE [unlisted-pkg-lics]`` | 544 | - ``LICENSE_<packagename> includes licenses (<licenses>) that are not listed in LICENSE [unlisted-pkg-lics]`` |
509 | 545 | ||
510 | The :term:`LICENSE` of the recipe should be a superset | 546 | The :term:`LICENSE` of the recipe should be a superset |