sanity.bbclass: warn on cargo config files outside the build tree
PATCH v3 1/1 sanity.bbclass: warn on cargo config files outside the build tree
From: Hemanth Kumar M D <[email protected]>
Cargo walks from CWD up to the filesystem root merging every .cargo/config[.toml] it finds. Any such file above BASE_WORKDIR is silently picked up and can override Yocto's linker, registry or compiler settings, leading to build failures.
Until cargo provides a proper fix upstream, add a warning so users get a clear diagnostic instead of a build error.
Upstream meta-issue: https://github.com/rust-lang/cargo/issues/9769
[YOCTO #15637]
Signed-off-by Hemanth Kumar M D <[email protected]>
--- meta/classes-global/sanity.bbclass | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+)
meta/classes-global/sanity.bbclass +25 -0
@@ -854,6 +854,30 @@ def sanity_check_locale(d): except locale.Error: raise_sanity_error("Your system needs to support the en_US.UTF-8 locale.", d) +def check_cargo_config(d): + # Cargo merges .cargo/config[.toml] from every directory between CWD and + # the filesystem root. Warn for anything found in ancestor directories + # above BASE_WORKDIR that Cargo would pick up silently. + from pathlib import Path + + base_workdir = Path(d.getVar('BASE_WORKDIR')) + found = [] + for ancestor in base_workdir.parents: + for name in ('.cargo/config', '.cargo/config.toml'): + cfg = ancestor / name + if cfg.exists(): + found.append(str(cfg)) + break + if found: + bb.warn("Cargo config file(s) found at %s which is/are outside the build " + "directory. Cargo will silently apply their settings during the " + "rust/cargo build and can override Yocto's settings like linker, " + "registry or compiler settings causing build failures. You can " + "either remove these file(s) or move your build directory outside " + "of %s to fix this. " + "See https://bugzilla.yoctoproject.org/show_bug.cgi?id=15637 for more details." + % (', '.join(found), Path(found[-1]).parents[1])) + def check_sanity_everybuild(status, d): import os, stat # Sanity tests which test the users environment so need to run at each build (or are so cheap
@@ -873,6 +897,7 @@ def check_sanity_everybuild(status, d): status.addresult('Bitbake version %s is required and version %s was found\n' % (minversion, bb.__version__)) sanity_check_locale(d) + check_cargo_config(d) paths = d.getVar('PATH').split(":") if "." in paths or "./" in paths or "" in paths:
Signature · 1 line
2.49.0