-
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
Add more documentation for artifact-dependencies. #12110
Conversation
r? @weihanglo (rustbot has picked a reviewer for you, use r? to override) |
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.
Looks good. Thanks!
src/doc/src/reference/unstable.md
Outdated
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. |
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.
Is this intentional? It feels a bit hard to understand. What about this?
* `"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
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.
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.
Thanks for that! @bors r+ |
☀️ Test successful - checks-actions |
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`
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`
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.