From 266e1d6ae83e3a7b1ba75f6360e744dab1ad2d10 Mon Sep 17 00:00:00 2001 From: Paul Eggleton Date: Tue, 27 Oct 2020 18:18:29 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-qa-checks.rst | 36 ++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) 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. Errors and Warnings =================== +.. _qa-check-libexec: + - ``: is using libexec please relocate to [libexec]`` The specified package contains files in ``/usr/libexec`` when the @@ -51,6 +53,7 @@ Errors and Warnings default can be changed (e.g. ``${libdir}``).   +.. _qa-check-rpaths: - ``package contains bad RPATH in file [rpaths]`` @@ -65,6 +68,7 @@ Errors and Warnings software.   +.. _qa-check-useless-rpaths: - ``: contains probably-redundant RPATH [useless-rpaths]`` @@ -77,6 +81,7 @@ Errors and Warnings the build of the software.   +.. _qa-check-file-rdeps: - `` requires , but no providers in its RDEPENDS [file-rdeps]`` @@ -88,6 +93,7 @@ Errors and Warnings built.   +.. _qa-check-build-deps: - `` rdepends on , but it isn't a build dependency? [build-deps]`` @@ -101,6 +107,7 @@ Errors and Warnings to add an explicit ``RDEPENDS`` for the dependency.   +.. _qa-check-dev-so: - ``non -dev/-dbg/nativesdk- package contains symlink .so: path '' [dev-so]`` @@ -112,6 +119,7 @@ Errors and Warnings file goes into an appropriate ``-dev`` package.   +.. _qa-check-staticdev: - ``non -staticdev package contains static .a library: path '' [staticdev]`` @@ -121,6 +129,7 @@ Errors and Warnings goes into an appropriate ``-staticdev`` package.   +.. _qa-check-libdir: - ``: found library in wrong location [libdir]`` @@ -133,6 +142,7 @@ Errors and Warnings :term:`INSANE_SKIP` for the package.   +.. _qa-check-debug-files: - ``non debug package contains .debug directory: path [debug-files]`` @@ -145,6 +155,7 @@ Errors and Warnings information on ``FILES``.   +.. _qa-check-arch: - ``Architecture did not match ( to ) on [arch]`` @@ -199,6 +210,7 @@ Errors and Warnings and verify that the compiler options being used are correct.   +.. _qa-check-textrel: - ``ELF binary '' has relocations in .text [textrel]`` @@ -218,6 +230,7 @@ Errors and Warnings http://www.akkadia.org/drepper/textrelocs.html.   +.. _qa-check-ldflags: - ``No GNU_HASH in the elf binary: '' [ldflags]`` @@ -233,6 +246,7 @@ Errors and Warnings TARGET_CC_ARCH += "${LDFLAGS}"   +.. _qa-check-xorg-driver-abi: - ``Package contains Xorg driver () but no xorg-abi- dependencies [xorg-driver-abi]`` @@ -245,6 +259,7 @@ Errors and Warnings to explicitly add dependencies to binary driver recipes.   +.. _qa-check-infodir: - ``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]`` @@ -256,6 +271,8 @@ Errors and Warnings rm ${D}${infodir}/dir   +.. _qa-check-symlink-to-sysroot: + - ``Symlink in points to TMPDIR [symlink-to-sysroot]`` The specified symlink points into :term:`TMPDIR` on the @@ -264,6 +281,7 @@ Errors and Warnings symlink to use a relative path or remove the symlink.   +.. _qa-check-la: - `` failed sanity test (workdir) in path [la]`` @@ -273,6 +291,7 @@ Errors and Warnings automatically itself.   +.. _qa-check-pkgconfig: - `` failed sanity test (tmpdir) in path [pkgconfig]`` @@ -283,6 +302,7 @@ Errors and Warnings are accessed.   +.. _qa-check-debug-deps: - `` rdepends on [debug-deps]`` @@ -305,6 +325,7 @@ Errors and Warnings manually (e.g. by adding to :term:`RDEPENDS`).   +.. _qa-check-dev-deps: - `` rdepends on [dev-deps]`` @@ -327,6 +348,7 @@ Errors and Warnings manually (e.g. by adding to :term:`RDEPENDS`).   +.. _qa-check-dep-cmp: - ``_ is invalid: () only comparisons <, =, >, <=, and >= are allowed [dep-cmp]`` @@ -341,6 +363,7 @@ Errors and Warnings adding to match those listed in the message.   +.. _qa-check-compile-host-path: - ``: The compile log indicates that host include and/or library paths were used. Please check the log '' for more information. [compile-host-path]`` @@ -351,6 +374,7 @@ Errors and Warnings file.   +.. _qa-check-install-host-path: - ``: The install log indicates that host include and/or library paths were used. Please check the log '' for more information. [install-host-path]`` @@ -361,6 +385,7 @@ Errors and Warnings file.   +.. _qa-check-configure-unsafe: - ``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 ''`` @@ -371,6 +396,7 @@ Errors and Warnings file.   +.. _qa-check-pkgname: - `` doesn't match the [a-z0-9.+-]+ regex [pkgname]`` @@ -384,6 +410,7 @@ Errors and Warnings change the package name appropriately.   +.. _qa-check-unknown-configure-option: - ``: configure was passed unrecognized options: [unknown-configure-option]`` @@ -401,6 +428,7 @@ Errors and Warnings accordingly.   +.. _qa-check-pn-overrides: - ``Recipe has PN of "" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]`` @@ -416,6 +444,7 @@ Errors and Warnings :term:`FILES` for additional information.   +.. _qa-check-pkgvarcheck: - ``: Variable is set as not being package specific, please fix this. [pkgvarcheck]`` @@ -433,6 +462,7 @@ Errors and Warnings assignments to these variables within your recipe.   +.. _qa-check-already-stripped: - ``File '' from was already stripped, this will prevent future debugging! [already-stripped]`` @@ -458,6 +488,7 @@ Errors and Warnings strip the symbols from the binaries.   +.. _qa-check-packages-list: - `` is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]`` @@ -467,6 +498,7 @@ Errors and Warnings already in the variable's value.   +.. _qa-check-files-invalid: - ``FILES variable for package contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]`` @@ -475,6 +507,7 @@ Errors and Warnings that there is only a single "/".   +.. _qa-check-installed-vs-shipped: - ``: Files/directories were installed but not shipped in any package [installed-vs-shipped]`` @@ -505,6 +538,9 @@ Errors and Warnings :term:`PRIVATE_LIBS` in the recipe that provides the private version of the library. + +.. _qa-check-unlisted-pkg-lics: + - ``LICENSE_ includes licenses () that are not listed in LICENSE [unlisted-pkg-lics]`` The :term:`LICENSE` of the recipe should be a superset -- cgit v1.2.3-54-g00ecf