From 6ac428e60aec8cecf340bccec16064c1a6c79df8 Mon Sep 17 00:00:00 2001 From: Samuel Moelius Date: Mon, 6 May 2024 13:33:23 +0000 Subject: [PATCH] Add note about "very verbose" flag --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 89c77f1..2024a1a 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,12 @@ Installing `build-wrap` requires two steps: - `BUILD_WRAP_ALLOW`: When set to a value other than `0`, `build-wrap` uses the following weakened strategy. If a running a build script under `BUILD_WRAP_CMD` fails, report the failure and rerun the build script normally. + Note that to see the reported failures, you must invoke Cargo with the `-vv` (["very verbose"]) flag, e.g.: + + ```sh + BUILD_WRAP_ALLOW=1 cargo build -vv + ``` + - `BUILD_WRAP_CMD`: Command used to execute a build script. Linux default: ```sh @@ -102,3 +108,4 @@ Given a build script `B`, its "wrapped" version `B'` contains a copy of `B` and [`cc-rs`]: https://github.com/rust-lang/cc-rs [`sandbox-exec`]: https://keith.github.io/xcode-man-pages/sandbox-exec.1.html [manner described above]: #how-build_wrap_cmd-is-expanded +["very verbose"]: https://doc.rust-lang.org/cargo/reference/build-scripts.html#outputs-of-the-build-script