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

Publish target's "doc" setting when emitting metadata #8869

Merged
merged 2 commits into from
Nov 24, 2020

Conversation

ayazhafiz
Copy link
Contributor

Prior to this commit cargo metadata would not emit the value of a
target's "doc" setting, used by cargo doc to determine whether
documentation should be generated. However, this information is useful
for machine programs interested in such targets, and the information is
already made available on the internal representation of a target, so
this commit just exposes that during target serialization for emit.

cf deadlinks/cargo-deadlinks#99

Prior to this commit `cargo metadata` would not emit the value of a
target's "doc" setting, used by `cargo doc` to determine whether
documentation should be generated. However, this information is useful
for machine programs interested in such targets, and the information is
already made available on the internal representation of a target, so
this commit just exposes that during target serialization for emit.

cf deadlinks/cargo-deadlinks#99
@rust-highfive
Copy link

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.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 18, 2020
@alexcrichton alexcrichton added the T-cargo Team: Cargo label Nov 20, 2020
@alexcrichton
Copy link
Member

Seems reasonable to me, thanks for the PR!

@rfcbot fcp merge

@rfcbot
Copy link
Collaborator

rfcbot commented Nov 20, 2020

Team member @alexcrichton has proposed to merge this. The next step is review by the rest of the tagged team members:

No concerns currently listed.

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

@rfcbot rfcbot added proposed-final-comment-period An FCP proposal has started, but not yet signed off. disposition-merge FCP with intent to merge labels Nov 20, 2020
@rfcbot
Copy link
Collaborator

rfcbot commented Nov 20, 2020

🔔 This is now entering its final comment period, as per the review above. 🔔

@rfcbot rfcbot added final-comment-period FCP — a period for last comments before action is taken and removed proposed-final-comment-period An FCP proposal has started, but not yet signed off. labels Nov 20, 2020
@ehuss
Copy link
Contributor

ehuss commented Nov 23, 2020

Thanks! Can you update the documentation? The section to update is at https://github.com/rust-lang/cargo/blob/master/src/doc/src/commands/cargo-metadata.md#output-format (just add the "doc" field next to the "doctest" one), and then in the src/doc directory run ./build-man.sh to rebuild the man pages (more information on how to do this is at https://github.com/rust-lang/cargo/tree/master/src/doc).

@ayazhafiz
Copy link
Contributor Author

@ehuss done

@ehuss
Copy link
Contributor

ehuss commented Nov 24, 2020

Thanks!

@bors r+

@bors
Copy link
Contributor

bors commented Nov 24, 2020

📌 Commit 600e231 has been approved by ehuss

@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 Nov 24, 2020
@bors
Copy link
Contributor

bors commented Nov 24, 2020

⌛ Testing commit 600e231 with merge 774c64c...

@bors
Copy link
Contributor

bors commented Nov 24, 2020

☀️ Test successful - checks-actions
Approved by: ehuss
Pushing 774c64c to master...

@bors bors merged commit 774c64c into rust-lang:master Nov 24, 2020
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 24, 2020
Update cargo

10 commits in 2af662e22177a839763ac8fb70d245a680b15214..bfca1cd22bf514d5f2b6c1089b0ded0ba7dfaa6e
2020-11-12 19:04:56 +0000 to 2020-11-24 16:33:21 +0000
- Shrink the progress bar, to give more space after it. (rust-lang/cargo#8892)
- Add some comments to the toml code (rust-lang/cargo#8887)
- Start searching git config at new path (rust-lang/cargo#8886)
- Fix documentation for CARGO_PRIMARY_PACKAGE. (rust-lang/cargo#8891)
- Bump to 0.51.0, update changelog (rust-lang/cargo#8894)
- Publish target's "doc" setting when emitting metadata (rust-lang/cargo#8869)
- Relaxes expectation of `cargo test` tests to accept test execution time (rust-lang/cargo#8884)
- Finish implementation of `-Zextra-link-arg`. (rust-lang/cargo#8441)
- Reproducible crate builds (rust-lang/cargo#8864)
- Allow resolver="1" to explicitly use the old resolver behavior. (rust-lang/cargo#8857)
@rfcbot rfcbot added finished-final-comment-period FCP complete to-announce and removed final-comment-period FCP — a period for last comments before action is taken labels Nov 30, 2020
ehuss added a commit to ehuss/cargo_metadata that referenced this pull request Oct 22, 2021
ehuss added a commit to ehuss/cargo_metadata that referenced this pull request Oct 24, 2021
@ehuss ehuss added this to the 1.50.0 milestone Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
disposition-merge FCP with intent to merge finished-final-comment-period FCP complete S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-cargo Team: Cargo to-announce
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants