mirror of
https://git.yoctoproject.org/poky
synced 2026-01-29 21:08:42 +01:00
ref-manual/qa-checks.rst: fix references
The references in this document do not work because references need to be associated to a title. Change the bullet list into a section separated document. This way we can cross-reference QA checks in other parts of the documentation (it was previously failing when attempted). The diff is a bit hard to digest, but there are no changes to content except for: - A fixed typo (inhert -> inherit) - Indentation (From yocto-docs rev: 93c30b8a430a981e8b89061c968a006a3e086353) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
committed by
Richard Purdie
parent
ae8b6bae17
commit
3aa2914a08
@@ -45,7 +45,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-already-stripped:
|
||||
|
||||
- ``File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped]``
|
||||
``already-stripped``
|
||||
--------------------
|
||||
|
||||
``File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped]``
|
||||
|
||||
Produced binaries have already been stripped prior to the build
|
||||
system extracting debug symbols. It is common for upstream software
|
||||
@@ -70,6 +73,9 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-arch:
|
||||
|
||||
``arch``
|
||||
--------
|
||||
|
||||
- ``Architecture did not match (<file_arch>, expected <machine_arch>) in <file> [arch]``
|
||||
|
||||
By default, the OpenEmbedded build system checks the Executable and
|
||||
@@ -120,7 +126,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-build-deps:
|
||||
|
||||
- ``<packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps]``
|
||||
``build-deps``
|
||||
--------------
|
||||
|
||||
``<packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps]``
|
||||
|
||||
There is a runtime dependency between the two specified packages, but
|
||||
there is nothing explicit within the recipe to enable the
|
||||
@@ -133,7 +142,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-buildpaths:
|
||||
|
||||
- ``File <filename> in package <packagename> contains reference to TMPDIR [buildpaths]``
|
||||
``buildpaths``
|
||||
--------------
|
||||
|
||||
``File <filename> in package <packagename> contains reference to TMPDIR [buildpaths]``
|
||||
|
||||
This check ensures that build system paths (including :term:`TMPDIR`) do not
|
||||
appear in output files, which not only leaks build system configuration into
|
||||
@@ -149,7 +161,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-configure-gettext:
|
||||
|
||||
- ``AM_GNU_GETTEXT used but no inherit gettext [configure-gettext]``
|
||||
``configure-gettext``
|
||||
---------------------
|
||||
|
||||
``AM_GNU_GETTEXT used but no inherit gettext [configure-gettext]``
|
||||
|
||||
If a recipe is building something that uses automake and the automake
|
||||
files contain an ``AM_GNU_GETTEXT`` directive then this check will fail
|
||||
@@ -159,7 +174,10 @@ Errors and Warnings
|
||||
|
||||
.. _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. [configure-unsafe]``
|
||||
``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. [configure-unsafe]``
|
||||
|
||||
The log for the :ref:`ref-tasks-configure` task
|
||||
indicates that paths on the host were searched for files, which is
|
||||
@@ -169,7 +187,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-debug-deps:
|
||||
|
||||
- ``<packagename> rdepends on <debug_packagename> [debug-deps]``
|
||||
``debug-deps``
|
||||
--------------
|
||||
|
||||
``<packagename> rdepends on <debug_packagename> [debug-deps]``
|
||||
|
||||
There is a dependency between the specified non-dbg package (i.e. a
|
||||
package whose name does not end in ``-dbg``) and a package that is a
|
||||
@@ -191,7 +212,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-debug-files:
|
||||
|
||||
- ``non debug package contains .debug directory: <packagename> path <path> [debug-files]``
|
||||
``debug-files``
|
||||
---------------
|
||||
|
||||
``non debug package contains .debug directory: <packagename> path <path> [debug-files]``
|
||||
|
||||
The specified package contains a ``.debug`` directory, which should
|
||||
not appear in anything but the ``-dbg`` package. This situation might
|
||||
@@ -203,7 +227,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-dep-cmp:
|
||||
|
||||
- ``<var>:<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp]``
|
||||
``dep-cmp``
|
||||
-----------
|
||||
|
||||
``<var>:<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp]``
|
||||
|
||||
If you are adding a versioned dependency relationship to one of the
|
||||
dependency variables (:term:`RDEPENDS`,
|
||||
@@ -217,7 +244,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-dev-deps:
|
||||
|
||||
- ``<packagename> rdepends on <dev_packagename> [dev-deps]``
|
||||
``dev-deps``
|
||||
------------
|
||||
|
||||
``<packagename> rdepends on <dev_packagename> [dev-deps]``
|
||||
|
||||
There is a dependency between the specified non-dev package (a package
|
||||
whose name does not end in ``-dev``) and a package that is a ``dev``
|
||||
@@ -239,7 +269,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-desktop:
|
||||
|
||||
- ``"Desktop file issue: ... [desktop]``
|
||||
``desktop``
|
||||
-----------
|
||||
|
||||
``"Desktop file issue: ... [desktop]``
|
||||
|
||||
Runs the ``desktop-file-validate`` program against any
|
||||
``.desktop`` files to validate their contents against the
|
||||
@@ -247,7 +280,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-dev-so:
|
||||
|
||||
- ``non -dev/-dbg/nativesdk- package contains symlink .so: <packagename> path '<path>' [dev-so]``
|
||||
``dev-so``
|
||||
----------
|
||||
|
||||
``non -dev/-dbg/nativesdk- package contains symlink .so: <packagename> path '<path>' [dev-so]``
|
||||
|
||||
Symlink ``.so`` files are for development only, and should therefore
|
||||
go into the ``-dev`` package. This situation might occur if you add
|
||||
@@ -258,7 +294,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-empty-dirs:
|
||||
|
||||
- ``<packagename> installs files in <path>, but it is expected to be empty [empty-dirs]``
|
||||
``empty-dirs``
|
||||
--------------
|
||||
|
||||
``<packagename> installs files in <path>, but it is expected to be empty [empty-dirs]``
|
||||
|
||||
The specified package is installing files into a directory that is
|
||||
normally expected to be empty (such as ``/tmp``). These files may
|
||||
@@ -268,7 +307,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-file-rdeps:
|
||||
|
||||
- ``<packagename> requires <files>, but no providers in its RDEPENDS [file-rdeps]``
|
||||
``file-rdeps``
|
||||
--------------
|
||||
|
||||
``<packagename> requires <files>, but no providers in its RDEPENDS [file-rdeps]``
|
||||
|
||||
A file-level dependency has been identified from the specified
|
||||
package on the specified files, but there is no explicit
|
||||
@@ -279,7 +321,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-files-invalid:
|
||||
|
||||
- ``FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]``
|
||||
``files-invalid``
|
||||
-----------------
|
||||
|
||||
``FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]``
|
||||
|
||||
The string "//" is invalid in a Unix path. Correct all occurrences
|
||||
where this string appears in a :term:`FILES` variable so
|
||||
@@ -287,7 +332,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-host-user-contaminated:
|
||||
|
||||
- ``<package name>: <path> is owned by gid/uid <gid/uid>, which is the same as the user running bitbake. This may be due to host contamination [host-user-contaminated]``
|
||||
``host-user-contaminated``
|
||||
--------------------------
|
||||
|
||||
``<package name>: <path> is owned by gid/uid <gid/uid>, which is the same as the user running bitbake. This may be due to host contamination [host-user-contaminated]``
|
||||
|
||||
Checks that no package produced by the
|
||||
recipe contains any files outside of ``/home`` with a user or group
|
||||
@@ -299,7 +347,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-infodir:
|
||||
|
||||
- ``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]``
|
||||
``infodir``
|
||||
-----------
|
||||
|
||||
``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]``
|
||||
|
||||
The ``/usr/share/info/dir`` should not be packaged. Add the following
|
||||
line to your :ref:`ref-tasks-install` task or to your
|
||||
@@ -309,7 +360,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-installed-vs-shipped:
|
||||
|
||||
- ``<recipename>: Files/directories were installed but not shipped in any package [installed-vs-shipped]``
|
||||
``installed-vs-shipped``
|
||||
------------------------
|
||||
|
||||
``<recipename>: Files/directories were installed but not shipped in any package [installed-vs-shipped]``
|
||||
|
||||
Files have been installed within the
|
||||
:ref:`ref-tasks-install` task but have not been
|
||||
@@ -325,27 +379,22 @@ Errors and Warnings
|
||||
- Delete the files at the end of the :ref:`ref-tasks-install` task if the
|
||||
files are not needed in any package.
|
||||
|
||||
- ``<oldpackage>-<oldpkgversion> was registered as shlib provider for <library>, changing it to <newpackage>-<newpkgversion> because it was built later``
|
||||
|
||||
This message means that both ``<oldpackage>`` and ``<newpackage>``
|
||||
provide the specified shared library. You can expect this message
|
||||
when a recipe has been renamed. However, if that is not the case, the
|
||||
message might indicate that a private version of a library is being
|
||||
erroneously picked up as the provider for a common library. If that
|
||||
is the case, you should add the library's ``.so`` filename to
|
||||
:term:`PRIVATE_LIBS` in the recipe that provides
|
||||
the private version of the library.
|
||||
|
||||
.. _qa-check-incompatible-license:
|
||||
|
||||
- ``Excluding <package> from packaging as it has incompatible license(s): <license> [incompatible-license]``
|
||||
``incompatible-license``
|
||||
------------------------
|
||||
|
||||
``Excluding <package> from packaging as it has incompatible license(s): <license> [incompatible-license]``
|
||||
|
||||
Report when packages are excluded from being created due to being marked with
|
||||
a license that is in :term:`INCOMPATIBLE_LICENSE`.
|
||||
|
||||
.. _qa-check-invalid-chars:
|
||||
|
||||
- ``<variable> has non <envoding> characters [invalid-chars]``
|
||||
``invalid-chars``
|
||||
-----------------
|
||||
|
||||
``<variable> has non <envoding> characters [invalid-chars]``
|
||||
|
||||
Checks that the recipe metadata variables :term:`DESCRIPTION`,
|
||||
:term:`SUMMARY`, :term:`LICENSE`, and :term:`SECTION` do not contain
|
||||
@@ -353,7 +402,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-invalid-packageconfig:
|
||||
|
||||
- ``<package>: invalid PACKAGECONFIG(s): <configs> [invalid-packageconfig]``
|
||||
``invalid-packageconfig``
|
||||
-------------------------
|
||||
|
||||
``<package>: invalid PACKAGECONFIG(s): <configs> [invalid-packageconfig]``
|
||||
|
||||
Checks that no undefined features are being added to :term:`PACKAGECONFIG`.
|
||||
For example, any name "foo" for which the following form does not exist::
|
||||
@@ -362,7 +414,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-la:
|
||||
|
||||
- ``<file> failed sanity test (workdir) in path <path> [la]``
|
||||
``la``
|
||||
------
|
||||
|
||||
``<file> failed sanity test (workdir) in path <path> [la]``
|
||||
|
||||
The specified ``.la`` file contains :term:`TMPDIR`
|
||||
paths. Any ``.la`` file containing these paths is incorrect since
|
||||
@@ -371,7 +426,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-ldflags:
|
||||
|
||||
- ``File '<file>' in package '<package>' doesn't have GNU_HASH (didn't pass LDFLAGS?) [ldflags]``
|
||||
``ldflags``
|
||||
-----------
|
||||
|
||||
``File '<file>' in package '<package>' doesn't have GNU_HASH (didn't pass LDFLAGS?) [ldflags]``
|
||||
|
||||
This indicates that binaries produced when building the recipe have
|
||||
not been linked with the :term:`LDFLAGS` options
|
||||
@@ -385,7 +443,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-libdir:
|
||||
|
||||
- ``<packagename>: found library in wrong location [libdir]``
|
||||
``libdir``
|
||||
----------
|
||||
|
||||
``<packagename>: found library in wrong location [libdir]``
|
||||
|
||||
The specified file may have been installed into an incorrect
|
||||
(possibly hardcoded) installation path. For example, this test will
|
||||
@@ -397,7 +458,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-libexec:
|
||||
|
||||
- ``<packagename>: <path> is using libexec please relocate to <libexecdir> [libexec]``
|
||||
``libexec``
|
||||
-----------
|
||||
|
||||
``<packagename>: <path> is using libexec please relocate to <libexecdir> [libexec]``
|
||||
|
||||
The specified package contains files in ``/usr/libexec`` when the
|
||||
distro configuration uses a different path for ``<libexecdir>`` By
|
||||
@@ -406,7 +470,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-mime:
|
||||
|
||||
- ``package contains mime types but does not inherit mime: <packagename> path '<file>' [mime]``
|
||||
``mime``
|
||||
--------
|
||||
|
||||
``package contains mime types but does not inherit mime: <packagename> path '<file>' [mime]``
|
||||
|
||||
The specified package contains mime type files (``.xml`` files in
|
||||
``${datadir}/mime/packages``) and yet does not inherit the
|
||||
@@ -416,7 +483,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-mime-xdg:
|
||||
|
||||
- ``package contains desktop file with key 'MimeType' but does not inhert mime-xdg: <packagename> path '<file>' [mime-xdg]``
|
||||
``mime-xdg``
|
||||
------------
|
||||
|
||||
``package contains desktop file with key 'MimeType' but does not inherit mime-xdg: <packagename> path '<file>' [mime-xdg]``
|
||||
|
||||
The specified package contains a .desktop file with a 'MimeType' key
|
||||
present, but does not inherit the :ref:`ref-classes-mime-xdg`
|
||||
@@ -426,7 +496,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-missing-update-alternatives:
|
||||
|
||||
- ``<recipename>: recipe defines ALTERNATIVE:<packagename> but doesn't inherit update-alternatives. This might fail during do_rootfs later! [missing-update-alternatives]``
|
||||
``missing-update-alternatives``
|
||||
-------------------------------
|
||||
|
||||
``<recipename>: recipe defines ALTERNATIVE:<packagename> but doesn't inherit update-alternatives. This might fail during do_rootfs later! [missing-update-alternatives]``
|
||||
|
||||
This check ensures that if a recipe sets the :term:`ALTERNATIVE` variable that the
|
||||
recipe also inherits :ref:`ref-classes-update-alternatives` such
|
||||
@@ -436,7 +509,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-packages-list:
|
||||
|
||||
- ``<packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]``
|
||||
``packages-list``
|
||||
-----------------
|
||||
|
||||
``<packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]``
|
||||
|
||||
Package names must appear only once in the
|
||||
:term:`PACKAGES` variable. You might receive this
|
||||
@@ -445,7 +521,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-patch-fuzz:
|
||||
|
||||
- ``Fuzz detected: <patch output> [patch-fuzz]``
|
||||
``patch-fuzz``
|
||||
--------------
|
||||
|
||||
``Fuzz detected: <patch output> [patch-fuzz]``
|
||||
|
||||
This check looks for evidence of "fuzz" when applying patches within the :ref:`ref-tasks-patch`
|
||||
task. Patch fuzz is a situation when the ``patch`` tool ignores some of the context
|
||||
@@ -519,6 +598,9 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-patch-status:
|
||||
|
||||
``patch-status``
|
||||
----------------
|
||||
|
||||
- ``Missing Upstream-Status in patch <patchfile> Please add according to <url> [patch-status]``
|
||||
|
||||
The ``Upstream-Status`` value is missing in the specified patch file's header.
|
||||
@@ -537,14 +619,20 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-pep517-backend:
|
||||
|
||||
- ``inherits setuptools3 but has pyproject.toml with <build backend>, use the correct class [pep517-backend]``
|
||||
``pep517-backend``
|
||||
------------------
|
||||
|
||||
``inherits setuptools3 but has pyproject.toml with <build backend>, use the correct class [pep517-backend]``
|
||||
|
||||
Checks that a recipe inheriting :ref:`ref-classes-setuptools3` has a
|
||||
PEP517-compliant backend.
|
||||
|
||||
.. _qa-check-perllocalpod:
|
||||
|
||||
- ``<packagename> contains perllocal.pod (<files>), should not be installed [perllocalpod]``
|
||||
``perllocalpod``
|
||||
----------------
|
||||
|
||||
``<packagename> contains perllocal.pod (<files>), should not be installed [perllocalpod]``
|
||||
|
||||
``perllocal.pod`` is an index file of locally installed modules and so shouldn't be
|
||||
installed by any distribution packages. The :ref:`ref-classes-cpan` class
|
||||
@@ -556,30 +644,45 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-perm-config:
|
||||
|
||||
- ``Fixup Perms: invalid config line <line> [perm-config]``
|
||||
``perm-config``
|
||||
---------------
|
||||
|
||||
``Fixup Perms: invalid config line <line> [perm-config]``
|
||||
|
||||
Reports lines in ``fs-perms.txt`` that have an invalid format.
|
||||
|
||||
.. _qa-check-perm-line:
|
||||
|
||||
- ``Fixup perms: <config> invalid line: <line> [perm-line]``
|
||||
``perm-line``
|
||||
-------------
|
||||
|
||||
``Fixup perms: <config> invalid line: <line> [perm-line]``
|
||||
|
||||
Reports lines in ``fs-perms.txt`` that have an invalid format.
|
||||
|
||||
.. _qa-check-perm-link:
|
||||
|
||||
- ``Fixup Perms: Unable to correct directory link, target already exists: <directory> -> <target> [perm-link]``
|
||||
``perm-link``
|
||||
-------------
|
||||
|
||||
``Fixup Perms: Unable to correct directory link, target already exists: <directory> -> <target> [perm-link]``
|
||||
|
||||
Reports lines in ``fs-perms.txt`` that specify 'link' where the specified
|
||||
target already exists.
|
||||
|
||||
.. _qa-check-perms:
|
||||
|
||||
- ``perms``: Currently, this check is unused but reserved.
|
||||
``perms``
|
||||
---------
|
||||
|
||||
Currently, this check is unused but reserved.
|
||||
|
||||
.. _qa-check-pkgconfig:
|
||||
|
||||
- ``<file> failed sanity test (tmpdir) in path <path> [pkgconfig]``
|
||||
``pkgconfig``
|
||||
-------------
|
||||
|
||||
``<file> failed sanity test (tmpdir) in path <path> [pkgconfig]``
|
||||
|
||||
The specified ``.pc`` file contains
|
||||
:term:`TMPDIR`\ ``/``\ :term:`WORKDIR`
|
||||
@@ -589,7 +692,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-pkgname:
|
||||
|
||||
- ``<packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname]``
|
||||
``pkgname``
|
||||
-----------
|
||||
|
||||
``<packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname]``
|
||||
|
||||
The convention within the OpenEmbedded build system (sometimes
|
||||
enforced by the package manager itself) is to require that package
|
||||
@@ -602,6 +708,9 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-pkgvarcheck:
|
||||
|
||||
``pkgvarcheck``
|
||||
---------------
|
||||
|
||||
- ``<recipefile>: Variable <variable> is set as not being package specific, please fix this. [pkgvarcheck]``
|
||||
|
||||
Certain variables (:term:`RDEPENDS`,
|
||||
@@ -627,7 +736,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-pn-overrides:
|
||||
|
||||
- ``Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]``
|
||||
``pn-overrides``
|
||||
----------------
|
||||
|
||||
``Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]``
|
||||
|
||||
The specified recipe has a name (:term:`PN`) value that
|
||||
appears in :term:`OVERRIDES`. If a recipe is named
|
||||
@@ -642,16 +754,38 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-shebang-size:
|
||||
|
||||
- ``<packagename>: <file> maximum shebang size exceeded, the maximum size is 128. [shebang-size]``
|
||||
``shebang-size``
|
||||
----------------
|
||||
|
||||
``<packagename>: <file> maximum shebang size exceeded, the maximum size is 128. [shebang-size]``
|
||||
|
||||
This check ensures that the shebang line (``#!`` in the first line) for a script
|
||||
is not longer than 128 characters, which can cause an error at runtime depending
|
||||
on the operating system. If you are seeing this message then the specified script
|
||||
may need to be patched to have a shorter in order to avoid runtime problems.
|
||||
|
||||
.. _qa-check-shlib-provider:
|
||||
|
||||
Shlib provider
|
||||
--------------
|
||||
|
||||
``<oldpackage>-<oldpkgversion> was registered as shlib provider for <library>, changing it to <newpackage>-<newpkgversion> because it was built later``
|
||||
|
||||
This message means that both ``<oldpackage>`` and ``<newpackage>``
|
||||
provide the specified shared library. You can expect this message
|
||||
when a recipe has been renamed. However, if that is not the case, the
|
||||
message might indicate that a private version of a library is being
|
||||
erroneously picked up as the provider for a common library. If that
|
||||
is the case, you should add the library's ``.so`` filename to
|
||||
:term:`PRIVATE_LIBS` in the recipe that provides
|
||||
the private version of the library.
|
||||
|
||||
.. _qa-check-space-around-equal:
|
||||
|
||||
- ``<filename>:<line number> has a lack of whitespace around the assignment: '<assignment>'``
|
||||
``space-around-equal``
|
||||
----------------------
|
||||
|
||||
``<filename>:<line number> has a lack of whitespace around the assignment: '<assignment>'``
|
||||
|
||||
This warning indicated that there is missing spaces around an assignment.
|
||||
|
||||
@@ -667,6 +801,9 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-src-uri-bad:
|
||||
|
||||
``src-uri-bad``
|
||||
---------------
|
||||
|
||||
- ``<recipename>: SRC_URI uses unstable GitHub archives [src-uri-bad]``
|
||||
|
||||
GitHub provides "archive" tarballs, however these can be re-generated
|
||||
@@ -686,7 +823,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-staticdev:
|
||||
|
||||
- ``non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev]``
|
||||
``staticdev``
|
||||
-------------
|
||||
|
||||
``non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev]``
|
||||
|
||||
Static ``.a`` library files should go into a ``-staticdev`` package.
|
||||
Change :term:`FILES` (and possibly
|
||||
@@ -695,7 +835,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-symlink-to-sysroot:
|
||||
|
||||
- ``Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot]``
|
||||
``symlink-to-sysroot``
|
||||
----------------------
|
||||
|
||||
``Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot]``
|
||||
|
||||
The specified symlink points into :term:`TMPDIR` on the
|
||||
host. Such symlinks will work on the host. However, they are clearly
|
||||
@@ -704,7 +847,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-recipe-naming:
|
||||
|
||||
- ``Recipe <recipe> appears native/nativesdk but is not, should inherit native/nativesdk``
|
||||
Recipe naming
|
||||
-------------
|
||||
|
||||
``Recipe <recipe> appears native/nativesdk but is not, should inherit native/nativesdk``
|
||||
|
||||
Checks that the recipe name and recipe class match, so that ``*-native``
|
||||
recipes inherit :ref:`ref-classes-native` and ``nativesdk-*`` recipes
|
||||
@@ -712,7 +858,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-rpaths:
|
||||
|
||||
- ``package <packagename> contains bad RPATH <rpath> in file <file> [rpaths]``
|
||||
``rpaths``
|
||||
----------
|
||||
|
||||
``package <packagename> contains bad RPATH <rpath> in file <file> [rpaths]``
|
||||
|
||||
The specified binary produced by the recipe contains dynamic library
|
||||
load paths (rpaths) that contain build system paths such as
|
||||
@@ -726,7 +875,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-textrel:
|
||||
|
||||
- ``ELF binary '<file>' has relocations in .text [textrel]``
|
||||
``textrel``
|
||||
-----------
|
||||
|
||||
``ELF binary '<file>' has relocations in .text [textrel]``
|
||||
|
||||
The specified ELF binary contains relocations in its ``.text``
|
||||
sections. This situation can result in a performance impact at
|
||||
@@ -744,7 +896,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-unhandled-features-check:
|
||||
|
||||
- ``<recipename>: recipe doesn't inherit features_check [unhandled-features-check]``
|
||||
``unhandled-features-check``
|
||||
----------------------------
|
||||
|
||||
``<recipename>: recipe doesn't inherit features_check [unhandled-features-check]``
|
||||
|
||||
This check ensures that if one of the variables that the
|
||||
:ref:`ref-classes-features_check` class supports (e.g.
|
||||
@@ -756,7 +911,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-unimplemented-ptest:
|
||||
|
||||
- ``<tool> tests detected [unimplemented-ptest]``
|
||||
``unimplemented-ptest``
|
||||
-----------------------
|
||||
|
||||
``<tool> tests detected [unimplemented-ptest]``
|
||||
|
||||
This check will detect if the source of the package contains some
|
||||
upstream-provided tests and, if so, that ptests are implemented for this
|
||||
@@ -766,7 +924,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-unknown-configure-option:
|
||||
|
||||
- ``<recipe>: configure was passed unrecognized options: <options> [unknown-configure-option]``
|
||||
``unknown-configure-option``
|
||||
----------------------------
|
||||
|
||||
``<recipe>: configure was passed unrecognized options: <options> [unknown-configure-option]``
|
||||
|
||||
The configure script is reporting that the specified options are
|
||||
unrecognized. This situation could be because the options were
|
||||
@@ -783,7 +944,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-unlisted-pkg-lics:
|
||||
|
||||
- ``LICENSE:<packagename> includes licenses (<licenses>) that are not listed in LICENSE [unlisted-pkg-lics]``
|
||||
``unlisted-pkg-lics``
|
||||
---------------------
|
||||
|
||||
``LICENSE:<packagename> includes licenses (<licenses>) that are not listed in LICENSE [unlisted-pkg-lics]``
|
||||
|
||||
The :term:`LICENSE` of the recipe should be a superset
|
||||
of all the licenses of all packages produced by this recipe. In other
|
||||
@@ -792,7 +956,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-useless-rpaths:
|
||||
|
||||
- ``<packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths]``
|
||||
``useless-rpaths``
|
||||
------------------
|
||||
|
||||
``<packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths]``
|
||||
|
||||
The specified binary produced by the recipe contains dynamic library
|
||||
load paths (rpaths) that on a standard system are searched by default
|
||||
@@ -804,7 +971,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-usrmerge:
|
||||
|
||||
- ``<packagename> package is not obeying usrmerge distro feature. /<path> should be relocated to /usr. [usrmerge]``
|
||||
``usrmerge``
|
||||
------------
|
||||
|
||||
``<packagename> package is not obeying usrmerge distro feature. /<path> should be relocated to /usr. [usrmerge]``
|
||||
|
||||
If ``usrmerge`` is in :term:`DISTRO_FEATURES`, this check will ensure that no package
|
||||
installs files to root (``/bin``, ``/sbin``, ``/lib``, ``/lib64``) directories. If you are seeing this
|
||||
@@ -815,6 +985,9 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-var-undefined:
|
||||
|
||||
``var-undefined``
|
||||
-----------------
|
||||
|
||||
- ``WORKDIR, DEPLOY_DIR, D, PN and PKGD all must be defined, unable to package [var-undefined]``
|
||||
|
||||
Reports when variables fundamental to packaging (i.e. :term:`WORKDIR`,
|
||||
@@ -823,7 +996,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-version-going-backwards:
|
||||
|
||||
- ``Package version for package <package> went backwards which would break package feeds (from <version2> to <version1>) [version-going-backwards]``
|
||||
``version-going-backwards``
|
||||
---------------------------
|
||||
|
||||
``Package version for package <package> went backwards which would break package feeds (from <version2> to <version1>) [version-going-backwards]``
|
||||
|
||||
If the :ref:`ref-classes-buildhistory` class is enabled, reports when a
|
||||
package being written out has a lower version than the previously written
|
||||
@@ -839,7 +1015,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-virtual-slash:
|
||||
|
||||
- ``<variable> is set to <value> but the substring 'virtual/' holds no meaning in this context. It only works for build time dependencies, not runtime ones. It is suggested to use 'VIRTUAL-RUNTIME_' variables instead.``
|
||||
``virtual-slash``
|
||||
-----------------
|
||||
|
||||
``<variable> is set to <value> but the substring 'virtual/' holds no meaning in this context. It only works for build time dependencies, not runtime ones. It is suggested to use 'VIRTUAL-RUNTIME_' variables instead. [virtual-slash]``
|
||||
|
||||
``virtual/`` is a convention intended for use in the build context
|
||||
(i.e. :term:`PROVIDES` and :term:`DEPENDS`) rather than the runtime
|
||||
@@ -848,7 +1027,10 @@ Errors and Warnings
|
||||
|
||||
.. _qa-check-xorg-driver-abi:
|
||||
|
||||
- ``Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi]``
|
||||
``xorg-driver-abi``
|
||||
-------------------
|
||||
|
||||
``Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi]``
|
||||
|
||||
The specified package contains an Xorg driver, but does not have a
|
||||
corresponding ABI package dependency. The xserver-xorg recipe
|
||||
|
||||
Reference in New Issue
Block a user