Suggest cargo add when installing library crate #11410

TrAyZeN · 2022-11-22T22:06:05Z

What does this PR try to resolve?

When using cargo install instead of cargo use the error message is the following:

error: there is nothing to install in `foo v0.0.1`, because it has no binaries
`cargo install` is only for installing programs, and can't be used with libraries.
To use a library crate, add it as a dependency in a Cargo project instead.

It would be good to suggest to the user to use cargo add.

How should we test and review this PR?

The no_binaries test from tests/testsuite/install.rs covers that case.

rustbot · 2022-11-22T22:06:09Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ehuss (or someone else) soon.

Please see the contribution instructions for more information.

hi-rustin

Looks good to me. Thanks!

eminence · 2022-11-23T02:40:08Z

Would it make sense to first check for a Cargo.toml in the current working directory before suggesting to use cargo add?

src/cargo/ops/cargo_install.rs

epage · 2022-11-23T03:01:29Z

@eminence

Would it make sense to first check for a Cargo.toml in the current working directory before suggesting to use cargo add?

That is a good idea for the current wording, though technically we'd be checking if we can discover one, rather than just checking the CWD.

We could possibly skip this though, depending on the wording we go with. For example, the proposed wording I gave I think can skip this as it just says how to use the dependency and says nothing about a current project.

TrAyZeN · 2022-11-23T20:14:01Z

I'll go with your wording as cargo add already searches for a Cargo.toml and returns an error if it can't find one.

epage · 2022-11-23T21:06:21Z

Unsure whats up with the CI failure in doc::scrape_examples_basic. @willcrichton ?

ehuss · 2022-11-23T21:10:46Z

I believe that is a known issue (#10120 and #10876). I haven't looked to see if #10343 will fix it, but it may.

willcrichton · 2022-11-24T02:34:36Z

The fingerprinting issue (#10876) will be fixed in #10343. Not sure why that would lead this this particular test being flaky... but we can revisit if it's still a problem after #10343 is merged.

weihanglo · 2022-11-25T11:46:26Z

src/cargo/ops/cargo_install.rs

-                pkg
+                 To use a library crate, add it as a dependency to a Cargo project with `cargo add {}`.",
+                pkg,
+                pkg.name()


This could be misleading. For example, if someone runs

cargo install --git https://github.com/hyperium/hyper.git

Cargo will then suggest cargo add hyper without the --git option.

Moreover, should the suggestion be more precise on --version and --features flag if those flags were provided as CLI arguments? Otherwise people blindly copy cargo add <pkg> might install a completely different version they desire.

I think it is a good idea to also suggest the --git option. Other source options that could be relevant are --path, --branch, --tag and --registry.

For the --version I am not sure whether we should. My use case is to suggest cargo add for users that used install instead of add, but --version is not a cargo add option.

Versions can be specified by the way around: cargo add <name>@<version-req>. I was saying that if someone run either cargo install mycrate --version 1.0.0 or cargo install mycrate@1.0.0, we may want cargo to suggest an equivalent cargo add mycrate@1.0.0 or else.

weihanglo · 2023-02-09T16:32:47Z

Friendly ping @TrAyZeN. Are you are still interested in working on this? The concern I raised here required to be resolved before merge.

BTW, epage called out a good idea here. Instead of providing a 100% correct command, we could also have an incomplete one as a hint, leaving the full command for users to figure out.

TrAyZeN · 2023-02-09T18:31:55Z

I am still interested in working on this :) I will make progress on this in the upcoming days.

TrAyZeN · 2023-02-18T11:57:45Z

I went with the incomplete command as a hint, for the simplicity of implementation.

I think it still provides value to new users by pointing them to the cargo add command. Then they can learn more about the command. Also if they simply copy and paste cargo add they will get an error message telling them that arguments are missing.

weihanglo

Looks good to me. Could you squash commits into one?

epage · 2023-02-23T18:33:56Z

Thanks!

@bors r+

bors · 2023-02-23T18:33:58Z

📌 Commit 98edd70 has been approved by epage

It is now in the queue for this repository.

bors · 2023-02-23T18:44:35Z

⌛ Testing commit 98edd70 with merge 0625b29...

bors · 2023-02-23T19:31:40Z

☀️ Test successful - checks-actions
Approved by: epage
Pushing 0625b29 to master...

10 commits in 9d5b32f503fc099c4064298465add14d4bce11e6..9880b408a3af50c08fab3dbf4aa2a972df71e951 2023-02-22 23:04:16 +0000 to 2023-02-28 19:39:39 +0000 - bump jobserver to respect `--jobserver-auth=fifo:PATH` (rust-lang/cargo#11767) - Addition of support for -F as an alias for --features (rust-lang/cargo#11774) - Added documentation for the configuration discovery of `cargo install` to the man pages (rust-lang/cargo#11763) - Fix Cargo removing the sparse+ prefix from sparse URLs in .crates.toml (rust-lang/cargo#11756) - Fix warning with tempfile (rust-lang/cargo#11771) - Error message for transitive artifact dependencies with targets the package doesn't directly interact with (rust-lang/cargo#11643) - Fix tests with nondeterministic ordering (rust-lang/cargo#11766) - Make some blocking tests non-blocking (rust-lang/cargo#11650) - Suggest cargo add when installing library crate (rust-lang/cargo#11410) - chore: bump is-terminal to 0.4.4 (rust-lang/cargo#11759)

Update cargo 10 commits in 9d5b32f503fc099c4064298465add14d4bce11e6..9880b408a3af50c08fab3dbf4aa2a972df71e951 2023-02-22 23:04:16 +0000 to 2023-02-28 19:39:39 +0000 - bump jobserver to respect `--jobserver-auth=fifo:PATH` (rust-lang/cargo#11767) - Addition of support for -F as an alias for --features (rust-lang/cargo#11774) - Added documentation for the configuration discovery of `cargo install` to the man pages (rust-lang/cargo#11763) - Fix Cargo removing the sparse+ prefix from sparse URLs in .crates.toml (rust-lang/cargo#11756) - Fix warning with tempfile (rust-lang/cargo#11771) - Error message for transitive artifact dependencies with targets the package doesn't directly interact with (rust-lang/cargo#11643) - Fix tests with nondeterministic ordering (rust-lang/cargo#11766) - Make some blocking tests non-blocking (rust-lang/cargo#11650) - Suggest cargo add when installing library crate (rust-lang/cargo#11410) - chore: bump is-terminal to 0.4.4 (rust-lang/cargo#11759) r? `@ghost`

Pkgsrc changes: * Adjust patches and cargo checksums to new versions. * Sadly, the patch to reduce the cargo verbosity no longer applies, so I've asked upstream about the proper way to get the old result. (so the build log becomes Quite Bloated for now). Upstream changes: Version 1.69.0 (2023-04-20) ========================== Language -------- - [Deriving built-in traits on packed structs works with `Copy` fields.] (rust-lang/rust#104429) - [Stabilize the `cmpxchg16b` target feature on x86 and x86_64.] (rust-lang/rust#106774) - [Improve analysis of trait bounds for associated types.] (rust-lang/rust#103695) - [Allow associated types to be used as union fields.] (rust-lang/rust#106938) - [Allow `Self: Autotrait` bounds on dyn-safe trait methods.] (rust-lang/rust#107082) - [Treat `str` as containing `[u8]` for auto trait purposes.] (rust-lang/rust#107941) Compiler -------- - [Upgrade `*-pc-windows-gnu` on CI to mingw-w64 v10 and GCC 12.2.] (rust-lang/rust#100178) - [Rework min_choice algorithm of member constraints.] (rust-lang/rust#105300) - [Support `true` and `false` as boolean flags in compiler arguments.] (rust-lang/rust#107043) - [Default `repr(C)` enums to `c_int` size.] (rust-lang/rust#107592) Libraries --------- - [Implement the unstable `DispatchFromDyn` for cell types, allowing downstream experimentation with custom method receivers.] (rust-lang/rust#97373) - [Document that `fmt::Arguments::as_str()` may return `Some(_)` in more cases after optimization, subject to change.] (rust-lang/rust#106823) - [Implement `AsFd` and `AsRawFd` for `Rc`.] (rust-lang/rust#107317) Stabilized APIs --------------- - [`CStr::from_bytes_until_nul`] (https://doc.rust-lang.org/stable/core/ffi/struct.CStr.html#method.from_bytes_until_nul) - [`core::ffi::FromBytesUntilNulError`] (https://doc.rust-lang.org/stable/core/ffi/struct.FromBytesUntilNulError.html) These APIs are now stable in const contexts: - [`SocketAddr::new`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.new) - [`SocketAddr::ip`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.ip) - [`SocketAddr::port`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.port) - [`SocketAddr::is_ipv4`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.is_ipv4) - [`SocketAddr::is_ipv6`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.is_ipv6) - [`SocketAddrV4::new`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV4.html#method.new) - [`SocketAddrV4::ip`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV4.html#method.ip) - [`SocketAddrV4::port`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV4.html#method.port) - [`SocketAddrV6::new`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.new) - [`SocketAddrV6::ip`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.ip) - [`SocketAddrV6::port`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.port) - [`SocketAddrV6::flowinfo`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.flowinfo) - [`SocketAddrV6::scope_id`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.scope_id) Cargo ----- - [Cargo now suggests `cargo fix` or `cargo clippy --fix` when compilation warnings are auto-fixable.] (rust-lang/cargo#11558) - [Cargo now suggests `cargo add` if you try to install a library crate.] (rust-lang/cargo#11410) - [Cargo now sets the `CARGO_BIN_NAME` environment variable also for binary examples.] (rust-lang/cargo#11705) Rustdoc ----- - [Vertically compact trait bound formatting.] (rust-lang/rust#102842) - [Only include stable lints in `rustdoc::all` group.] (rust-lang/rust#106316) - [Compute maximum Levenshtein distance based on the query.] (rust-lang/rust#107141) - [Remove inconsistently-present sidebar tooltips.] (rust-lang/rust#107490) - [Search by macro when query ends with `!`.] (rust-lang/rust#108143) Compatibility Notes ------------------- - [The `rust-analysis` component from `rustup` now only contains a warning placeholder.] (rust-lang/rust#101841) This was primarily intended for RLS, and the corresponding `-Zsave-analysis` flag has been removed from the compiler as well. - [Unaligned references to packed fields are now a hard error.] (rust-lang/rust#102513) This has been a warning since 1.53, and denied by default with a future-compatibility warning since 1.62. - [Update the minimum external LLVM to 14.] (rust-lang/rust#107573) - [Cargo now emits errors on invalid characters in a registry token.] (rust-lang/cargo#11600) - [When `default-features` is set to false of a workspace dependency, and an inherited dependency of a member has `default-features = true`, Cargo will enable default features of that dependency.] (rust-lang/cargo#11409) - [Cargo denies `CARGO_HOME` in the `[env]` configuration table. Cargo itself doesn't pick up this value, but recursive calls to cargo would, which was not intended.] (rust-lang/cargo#11644) - [Debuginfo for build dependencies is now off if not explicitly set. This is expected to improve the overall build time.] (rust-lang/cargo#11252) Internal Changes ---------------- These changes do not affect any public interfaces of Rust, but they represent significant improvements to the performance or internals of rustc and related tools. - [Move `format_args!()` into AST (and expand it during AST lowering)] (rust-lang/rust#106745)

Pkgsrc changes: * Adjust patches and cargo checksums to new versions. Upstream changes: Version 1.69.0 (2023-04-20) ========================== Language -------- - [Deriving built-in traits on packed structs works with `Copy` fields.] (rust-lang/rust#104429) - [Stabilize the `cmpxchg16b` target feature on x86 and x86_64.] (rust-lang/rust#106774) - [Improve analysis of trait bounds for associated types.] (rust-lang/rust#103695) - [Allow associated types to be used as union fields.] (rust-lang/rust#106938) - [Allow `Self: Autotrait` bounds on dyn-safe trait methods.] (rust-lang/rust#107082) - [Treat `str` as containing `[u8]` for auto trait purposes.] (rust-lang/rust#107941) Compiler -------- - [Upgrade `*-pc-windows-gnu` on CI to mingw-w64 v10 and GCC 12.2.] (rust-lang/rust#100178) - [Rework min_choice algorithm of member constraints.] (rust-lang/rust#105300) - [Support `true` and `false` as boolean flags in compiler arguments.] (rust-lang/rust#107043) - [Default `repr(C)` enums to `c_int` size.] (rust-lang/rust#107592) Libraries --------- - [Implement the unstable `DispatchFromDyn` for cell types, allowing downstream experimentation with custom method receivers.] (rust-lang/rust#97373) - [Document that `fmt::Arguments::as_str()` may return `Some(_)` in more cases after optimization, subject to change.] (rust-lang/rust#106823) - [Implement `AsFd` and `AsRawFd` for `Rc`.] (rust-lang/rust#107317) Stabilized APIs --------------- - [`CStr::from_bytes_until_nul`] (https://doc.rust-lang.org/stable/core/ffi/struct.CStr.html#method.from_bytes_until_nul) - [`core::ffi::FromBytesUntilNulError`] (https://doc.rust-lang.org/stable/core/ffi/struct.FromBytesUntilNulError.html) These APIs are now stable in const contexts: - [`SocketAddr::new`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.new) - [`SocketAddr::ip`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.ip) - [`SocketAddr::port`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.port) - [`SocketAddr::is_ipv4`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.is_ipv4) - [`SocketAddr::is_ipv6`] (https://doc.rust-lang.org/stable/std/net/enum.SocketAddr.html#method.is_ipv6) - [`SocketAddrV4::new`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV4.html#method.new) - [`SocketAddrV4::ip`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV4.html#method.ip) - [`SocketAddrV4::port`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV4.html#method.port) - [`SocketAddrV6::new`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.new) - [`SocketAddrV6::ip`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.ip) - [`SocketAddrV6::port`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.port) - [`SocketAddrV6::flowinfo`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.flowinfo) - [`SocketAddrV6::scope_id`] (https://doc.rust-lang.org/stable/std/net/struct.SocketAddrV6.html#method.scope_id) Cargo ----- - [Cargo now suggests `cargo fix` or `cargo clippy --fix` when compilation warnings are auto-fixable.] (rust-lang/cargo#11558) - [Cargo now suggests `cargo add` if you try to install a library crate.] (rust-lang/cargo#11410) - [Cargo now sets the `CARGO_BIN_NAME` environment variable also for binary examples.] (rust-lang/cargo#11705) Rustdoc ----- - [Vertically compact trait bound formatting.] (rust-lang/rust#102842) - [Only include stable lints in `rustdoc::all` group.] (rust-lang/rust#106316) - [Compute maximum Levenshtein distance based on the query.] (rust-lang/rust#107141) - [Remove inconsistently-present sidebar tooltips.] (rust-lang/rust#107490) - [Search by macro when query ends with `!`.] (rust-lang/rust#108143) Compatibility Notes ------------------- - [The `rust-analysis` component from `rustup` now only contains a warning placeholder.] (rust-lang/rust#101841) This was primarily intended for RLS, and the corresponding `-Zsave-analysis` flag has been removed from the compiler as well. - [Unaligned references to packed fields are now a hard error.] (rust-lang/rust#102513) This has been a warning since 1.53, and denied by default with a future-compatibility warning since 1.62. - [Update the minimum external LLVM to 14.] (rust-lang/rust#107573) - [Cargo now emits errors on invalid characters in a registry token.] (rust-lang/cargo#11600) - [When `default-features` is set to false of a workspace dependency, and an inherited dependency of a member has `default-features = true`, Cargo will enable default features of that dependency.] (rust-lang/cargo#11409) - [Cargo denies `CARGO_HOME` in the `[env]` configuration table. Cargo itself doesn't pick up this value, but recursive calls to cargo would, which was not intended.] (rust-lang/cargo#11644) - [Debuginfo for build dependencies is now off if not explicitly set. This is expected to improve the overall build time.] (rust-lang/cargo#11252) Internal Changes ---------------- These changes do not affect any public interfaces of Rust, but they represent significant improvements to the performance or internals of rustc and related tools. - [Move `format_args!()` into AST (and expand it during AST lowering)] (rust-lang/rust#106745)

rustbot assigned ehuss Nov 22, 2022

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 22, 2022

hi-rustin approved these changes Nov 23, 2022

View reviewed changes

epage reviewed Nov 23, 2022

View reviewed changes

src/cargo/ops/cargo_install.rs Outdated Show resolved Hide resolved

epage approved these changes Nov 23, 2022

View reviewed changes

weihanglo reviewed Nov 25, 2022

View reviewed changes

weihanglo added S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 8, 2022

rustbot added the Command-install label Feb 18, 2023

weihanglo approved these changes Feb 18, 2023

View reviewed changes

Suggest cargo add when installing library crate

98edd70

TrAyZeN force-pushed the master branch from 4269a31 to 98edd70 Compare February 18, 2023 16:39

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: The marked PR is awaiting some action (such as code changes) from the PR author. labels Feb 23, 2023

bors merged commit 0625b29 into rust-lang:master Feb 23, 2023

bors mentioned this pull request Feb 23, 2023

Don't compile on install without binaries #10842

Closed

weihanglo mentioned this pull request Feb 28, 2023

Update cargo rust-lang/rust#108582

Merged

ehuss added this to the 1.69.0 milestone Mar 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Suggest cargo add when installing library crate #11410

Suggest cargo add when installing library crate #11410

TrAyZeN commented Nov 22, 2022

rustbot commented Nov 22, 2022

hi-rustin left a comment

eminence commented Nov 23, 2022

epage commented Nov 23, 2022

TrAyZeN commented Nov 23, 2022

epage commented Nov 23, 2022

ehuss commented Nov 23, 2022

willcrichton commented Nov 24, 2022

weihanglo Nov 25, 2022 •

edited

TrAyZeN Nov 28, 2022

weihanglo Nov 29, 2022

weihanglo commented Feb 9, 2023

TrAyZeN commented Feb 9, 2023

TrAyZeN commented Feb 18, 2023

weihanglo left a comment

epage commented Feb 23, 2023

bors commented Feb 23, 2023

bors commented Feb 23, 2023

bors commented Feb 23, 2023

Suggest cargo add when installing library crate #11410

Suggest cargo add when installing library crate #11410

Conversation

TrAyZeN commented Nov 22, 2022

What does this PR try to resolve?

How should we test and review this PR?

rustbot commented Nov 22, 2022

hi-rustin left a comment

Choose a reason for hiding this comment

eminence commented Nov 23, 2022

epage commented Nov 23, 2022

TrAyZeN commented Nov 23, 2022

epage commented Nov 23, 2022

ehuss commented Nov 23, 2022

willcrichton commented Nov 24, 2022

weihanglo Nov 25, 2022 • edited

Choose a reason for hiding this comment

TrAyZeN Nov 28, 2022

Choose a reason for hiding this comment

weihanglo Nov 29, 2022

Choose a reason for hiding this comment

weihanglo commented Feb 9, 2023

TrAyZeN commented Feb 9, 2023

TrAyZeN commented Feb 18, 2023

weihanglo left a comment

Choose a reason for hiding this comment

epage commented Feb 23, 2023

bors commented Feb 23, 2023

bors commented Feb 23, 2023

bors commented Feb 23, 2023

weihanglo Nov 25, 2022 •

edited