-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc(cargo-tree): mention it considering feature unification #11282
Conversation
r? @ehuss (rust-highfive has picked a reviewer for you, use r? to override) |
src/doc/man/cargo-tree.md
Outdated
This command takes feature unifications into account. That is to say, the | ||
command shows a graph much closer to a feature-unified graph Cargo will build, | ||
rather than what you list in `Cargo.toml`. For instance, if you have the same |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For most people, I feel like the two leading sentences will lose people as they are speaking in cargo jargon.
Maybe just lead with "This command shows a graph much closer to a feature-unified graph that Cargo will build than what you list in Cargo.toml
. ..." That gives people more upfront context so hopefully they don't get lost as much.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fantastic advice! I'll keep in mind we're writing a guide for users, not contributors.
Updated with 4a76339. Thank you!
32e10cc
to
5b048c6
Compare
5b048c6
to
4a76339
Compare
@bors r+ |
☀️ Test successful - checks-actions |
5 commits in 071eeaf210708219a5a1b2c4728ca2f97df7f2ae..9210810d1fd7b51ae0439a0a363cc50e36963455 2022-10-22 01:17:55 +0000 to 2022-10-25 22:31:50 +0000 - Fix 410 gone response handling (rust-lang/cargo#11286) - Fix inequality in "stale mtime" log messages (rust-lang/cargo#11281) - doc(cargo-tree): mention it considering feature unification (rust-lang/cargo#11282) - Improve the error message if `publish` is `false` or empty list (rust-lang/cargo#11280) - Add test for deleted index entry (rust-lang/cargo#11278)
Update cargo 5 commits in 071eeaf210708219a5a1b2c4728ca2f97df7f2ae..9210810d1fd7b51ae0439a0a363cc50e36963455 2022-10-22 01:17:55 +0000 to 2022-10-25 22:31:50 +0000 - Fix 410 gone response handling (rust-lang/cargo#11286) - Fix inequality in "stale mtime" log messages (rust-lang/cargo#11281) - doc(cargo-tree): mention it considering feature unification (rust-lang/cargo#11282) - Improve the error message if `publish` is `false` or empty list (rust-lang/cargo#11280) - Add test for deleted index entry (rust-lang/cargo#11278)
Update cargo 5 commits in 071eeaf210708219a5a1b2c4728ca2f97df7f2ae..9210810d1fd7b51ae0439a0a363cc50e36963455 2022-10-22 01:17:55 +0000 to 2022-10-25 22:31:50 +0000 - Fix 410 gone response handling (rust-lang/cargo#11286) - Fix inequality in "stale mtime" log messages (rust-lang/cargo#11281) - doc(cargo-tree): mention it considering feature unification (rust-lang/cargo#11282) - Improve the error message if `publish` is `false` or empty list (rust-lang/cargo#11280) - Add test for deleted index entry (rust-lang/cargo#11278)
What does this PR try to resolve?
Mention that
cargo tree
takes feature unification into account.Most the contents come from #11261 (comment) and #11261 (comment).
Fixes #11261
How should we test and review this PR?
Checkout man page:
Checkout the book:
I am trying to slim down the amount added. If you have any suggestion to reduce the amount please share it.