summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@microsoft.com>2022-10-07 09:32:24 +1300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-10-19 17:32:56 +0100
commit3dbc1e83f26ab1575b93c83273c9c9877d14633f (patch)
tree9dd605d95b5c980fe9ad4868dcadf46e2b078b73
parent32ba43072b622c93a567ddf1da2cc59ada4a37b0 (diff)
downloadpoky-3dbc1e83f26ab1575b93c83273c9c9877d14633f.tar.gz
ref-manual: update buildpaths QA check documentation
The buildpaths QA check is now practically usable and enabled by default, so update the comment and add a section with the warning message since users may start seeing it in their builds. (From yocto-docs rev: a14997e3b8576cd1a6e1c38d13b5b8e05ac03b88) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/classes.rst4
-rw-r--r--documentation/ref-manual/qa-checks.rst16
2 files changed, 18 insertions, 2 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 6c60d414ca..d94db03616 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1008,8 +1008,8 @@ Here are the tests you can list with the :term:`WARN_QA` and
1008 software, like bootloaders, might need to bypass this check. 1008 software, like bootloaders, might need to bypass this check.
1009 1009
1010- ``buildpaths:`` Checks for paths to locations on the build host 1010- ``buildpaths:`` Checks for paths to locations on the build host
1011 inside the output files. Currently, this test triggers too many false 1011 inside the output files. Not only can these leak information about
1012 positives and thus is not normally enabled. 1012 the build environment, they also hinder binary reproducibility.
1013 1013
1014- ``build-deps:`` Determines if a build-time dependency that is 1014- ``build-deps:`` Determines if a build-time dependency that is
1015 specified through :term:`DEPENDS`, explicit 1015 specified through :term:`DEPENDS`, explicit
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 9455bec3fd..fb31dc16f9 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -748,6 +748,22 @@ Errors and Warnings
748 other things in the patches, those can be discarded. 748 other things in the patches, those can be discarded.
749 749
750 750
751.. _qa-check-buildpaths:
752
753- ``File <filename> in package <packagename> contains reference to TMPDIR [buildpaths]``
754
755 This check ensures that build system paths (including :term:`TMPDIR`) do not
756 appear in output files, which not only leaks build system configuration into
757 the target, but also hinders binary reproducibility as the output will change
758 if the build system configuration changes.
759
760 Typically these paths will enter the output through some mechanism in the
761 configuration or compilation of the software being built by the recipe. To
762 resolve this issue you will need to determine how the detected path is
763 entering the output. Sometimes it may require adjusting scripts or code to
764 use a relative path rather than an absolute one, or to pick up the path from
765 runtime configuration or environment variables.
766
751 767
752Configuring and Disabling QA Checks 768Configuring and Disabling QA Checks
753=================================== 769===================================