From cefb386e7813b26c67196b8966991a971b9e2dce Mon Sep 17 00:00:00 2001 From: Charles Hall Date: Wed, 16 Aug 2023 14:27:19 -0700 Subject: cargo-llvm-cov: document test failure modes --- pkgs/development/tools/rust/cargo-llvm-cov/default.nix | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/pkgs/development/tools/rust/cargo-llvm-cov/default.nix b/pkgs/development/tools/rust/cargo-llvm-cov/default.nix index 1b9449e0dfc..24e8f458b60 100644 --- a/pkgs/development/tools/rust/cargo-llvm-cov/default.nix +++ b/pkgs/development/tools/rust/cargo-llvm-cov/default.nix @@ -1,3 +1,20 @@ +# If the tests are broken, it's probably for one of two reasons: +# +# 1. The version of llvm used doesn't match the expectations of rustc and/or +# cargo-llvm-cov. This is relatively unlikely because we pull llvm out of +# rustc's attrset, so it *should* be the right version as long as this is the +# case. +# 2. Nixpkgs has changed its rust infrastructure in a way that causes +# cargo-llvm-cov to misbehave under test. It's likely that even though the +# tests are failing, cargo-llvm-cov will still function properly in actual +# use. This has happened before, and is described [here][0] (along with a +# feature request that would fix this instance of the problem). +# +# For previous test-troubleshooting discussion, see [here][1]. +# +# [0]: https://github.com/taiki-e/cargo-llvm-cov/issues/242 +# [1]: https://github.com/NixOS/nixpkgs/pull/197478 + { stdenv , lib , fetchurl -- cgit 1.4.1