Skip to content
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

Merged
merged 1 commit into from
Oct 24, 2022

Conversation

weihanglo
Copy link
Member

@weihanglo weihanglo commented Oct 24, 2022

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:

cargo run -- help tree

Checkout the book:

mdbook serve src/doc

I am trying to slim down the amount added. If you have any suggestion to reduce the amount please share it.

@rust-highfive
Copy link

r? @ehuss

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 24, 2022
Comment on lines 58 to 60
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
Copy link
Contributor

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.

Copy link
Member Author

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!

@epage
Copy link
Contributor

epage commented Oct 24, 2022

@bors r+

@bors
Copy link
Contributor

bors commented Oct 24, 2022

📌 Commit 4a76339 has been approved by epage

It is now in the queue for this repository.

@bors 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-review Status: Awaiting review from the assignee but also interested parties. labels Oct 24, 2022
@bors
Copy link
Contributor

bors commented Oct 24, 2022

⌛ Testing commit 4a76339 with merge 62b6d5a...

@bors
Copy link
Contributor

bors commented Oct 24, 2022

☀️ Test successful - checks-actions
Approved by: epage
Pushing 62b6d5a to master...

@bors bors merged commit 62b6d5a into rust-lang:master Oct 24, 2022
compiler-errors pushed a commit to compiler-errors/rust that referenced this pull request Oct 26, 2022
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)
compiler-errors added a commit to compiler-errors/rust that referenced this pull request Oct 26, 2022
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)
JohnTitor pushed a commit to JohnTitor/rust that referenced this pull request Oct 26, 2022
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)
@weihanglo weihanglo deleted the doc/cargo-tree branch October 27, 2022 07:25
@ehuss ehuss added this to the 1.66.0 milestone Oct 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cargo tree show optinal dependency when a crate is include as a dev-dependencies
5 participants