-
Notifications
You must be signed in to change notification settings - Fork 212
Add support for cargo-args in package metadata #1374
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
Conversation
|
||
# List of command line arguments for `cargo`. | ||
# | ||
# These cannot be a subcommand, they may only be options. |
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.
Maybe mention that these will be passed to multiple subcommands so need to be generally applicable.
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 that true? I thought we only ever use the rustdoc
subcommand.
I can add a disclaimer that we don't guarantee the subcommand and you should make these independent, but I don't know how useful that is in practice - they can't truly be independent because e.g. cargo new
won't have any useful options, and I think almost everything else is shared between rustdoc
and doc
.
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.
We use cargo metadata
too I think.
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.
Yes, but we don't pass user-defined args there:
docs.rs/src/utils/cargo_metadata.rs
Lines 17 to 21 in 20aa706
let res = Command::new(workspace, toolchain.cargo()) | |
.args(&["metadata", "--format-version", "1"]) | |
.cd(source_dir) | |
.log_output(false) | |
.run_capture()?; |
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.
If it helps, the only place we call cargo_args()
is for prepare_command
:
docs.rs/src/docbuilder/rustwide_builder.rs
Line 588 in 20aa706
let cargo_args = metadata.cargo_args(&cargo_args, &rustdoc_flags_extras); |
which is only used for doc coverage and actually generating the documentation.
Closes #1353