Improve error message when a library is not found #158
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mostly just small tweaks to existing output, including the following new output: - Potential packages to install - Items in PKG_CONFIG_PATH - Command invocation
|
Missed some features introduced in 1.57; specifically |
…bles Before, this was accomplished by using `get_env` and `get_args` manually, but these features are unavailable in 1.30 (current MSRV). To get around this, `Command` is wrapped as `WrappedCommand` and tracks any environment variables or arguments that are set by the caller. Then, the `Display` implementation actually handles pretty-printing the invocation, with the added benefit that other errors can take advantage of this nicer output!
sdroege
reviewed
Dec 19, 2023
src/lib.rs
Outdated
| let hint = if let Some(search_path) = search_path { | ||
| writeln!( | ||
| f, | ||
| "PKG_CONFIG_PATH contains the following:\n{}", |
There was a problem hiding this comment.
Isn't this confusing for NixOS users? Maybe remember from which variable the search path comes and print that here.
Looks good to me otherwise, thanks a lot :)
There was a problem hiding this comment.
Ah, good catch! Will write a quick fix.
As pointed out by @sdroege in rust-lang#158, Nix users would be misled when `PKG_CONFIG_PATH_FOR_TARGET` is listed in error output but mistakenly named `PKG_CONFIG_PATH`.
|
Apologies for the commit spam, I'm very out of practice using Git! Please let me know if there is anything else I can do. |
sdroege
approved these changes
Dec 20, 2023
|
Thanks :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've noticed that people trying to build a crate which links against a missing library can sometimes be confused by this library's error output. This PR introduces a re-worked error message for that case that focuses on communicating:
Before (trimmed
build.rsoutput for libsodium-sys-stable):After:
Thanks to everyone for their invaluable feedback on zulip: https://rust-lang.zulipchat.com/#narrow/stream/351149-t-libs.2Fcrates/topic/More.20helpful.20pkg-config.20output
If there's anything that should be changed please let me know :)