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

Add more documentation for artifact-dependencies. #12110

Merged
merged 2 commits into from
May 9, 2023

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented May 8, 2023

This adds some more detailed documentation for artifact-dependencies. Whenever I need to work with it, I look at this section and essentially not find any of the information that I am looking for. This fills it out with some of the information that I think the documentation will eventually need.

@rustbot
Copy link
Collaborator

rustbot commented May 8, 2023

r? @weihanglo

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 8, 2023
Copy link
Member

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thanks!

This field allows specifying which target will be built, and made available as a binary at build time:

* `"bin"` --- Compiled executable binaries, corresponding to all of the `[[bin]]` sections in the dependency's manifest.
* `"bin:`*name*`"` --- Compiled executable binary, corresponding to a specific binary target specified by its name.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Is this intentional? It feels a bit hard to understand. What about this?

Suggested change
* `"bin:`*name*`"` --- Compiled executable binary, corresponding to a specific binary target specified by its name.
* `"bin:<bin-name>"` --- Compiled executable binary, corresponding to a specific binary target specified by its name.

We already used the same syntax here: https://doc.rust-lang.org/nightly/cargo/reference/cargo-targets.html#binaries

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! I was trying something different because I'm not too enthusiastic about using the <foo> placeholders. I'm concerned there might be confusion about the reader not knowing those are placeholders, or whether or not there is significance to the angled brackets (like whether or not those need to be kept in the output). But I suppose nobody has mentioned that, and it isn't likely to be too confusing.

@weihanglo
Copy link
Member

Thanks for that!

@bors r+

@bors
Copy link
Contributor

bors commented May 9, 2023

📌 Commit 0350e79 has been approved by weihanglo

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 May 9, 2023
@bors
Copy link
Contributor

bors commented May 9, 2023

⌛ Testing commit 0350e79 with merge 0e93732...

@bors
Copy link
Contributor

bors commented May 9, 2023

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 0e93732 to master...

@bors bors merged commit 0e93732 into rust-lang:master May 9, 2023
bors added a commit to rust-lang-ci/rust that referenced this pull request May 10, 2023
Update cargo

10 commits in 569b648b5831ae8a515e90c80843a5287c3304ef..26b73d15a68fb94579f6d3590585ec0e9d81d3d5
2023-05-05 15:49:44 +0000 to 2023-05-09 20:28:03 +0000
- Update the semver-check script to be able to run in any directory. (rust-lang/cargo#12117)
- Semver: Note that it is not a breaking change to make an unsafe function safe (rust-lang/cargo#12116)
- Add more documentation for artifact-dependencies. (rust-lang/cargo#12110)
- changelog: move registry query fixes to the right place (rust-lang/cargo#12086)
- Disallow RUSTUP_TOOLCHAIN in the [env] table. (rust-lang/cargo#12107)
- Disallow RUSTUP_HOME in the [env] table. (rust-lang/cargo#12101)
- Fix redacting tokens in http debug. (rust-lang/cargo#12095)
- Fix self_signed_should_fail for macOS. (rust-lang/cargo#12097)
- Update git2 (rust-lang/cargo#12096)
- do not try an exponential number of package names (rust-lang/cargo#12083)

r? `@ghost`
RalfJung pushed a commit to RalfJung/miri that referenced this pull request May 10, 2023
Update cargo

10 commits in 569b648b5831ae8a515e90c80843a5287c3304ef..26b73d15a68fb94579f6d3590585ec0e9d81d3d5
2023-05-05 15:49:44 +0000 to 2023-05-09 20:28:03 +0000
- Update the semver-check script to be able to run in any directory. (rust-lang/cargo#12117)
- Semver: Note that it is not a breaking change to make an unsafe function safe (rust-lang/cargo#12116)
- Add more documentation for artifact-dependencies. (rust-lang/cargo#12110)
- changelog: move registry query fixes to the right place (rust-lang/cargo#12086)
- Disallow RUSTUP_TOOLCHAIN in the [env] table. (rust-lang/cargo#12107)
- Disallow RUSTUP_HOME in the [env] table. (rust-lang/cargo#12101)
- Fix redacting tokens in http debug. (rust-lang/cargo#12095)
- Fix self_signed_should_fail for macOS. (rust-lang/cargo#12097)
- Update git2 (rust-lang/cargo#12096)
- do not try an exponential number of package names (rust-lang/cargo#12083)

r? `@ghost`
@ehuss ehuss added this to the 1.71.0 milestone May 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation 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.

4 participants