Skip to content

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

Merged
merged 1 commit into from
Apr 22, 2021

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Apr 20, 2021

Closes #1353

@jyn514 jyn514 added S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed A-builds Area: Building the documentation for a crate labels Apr 20, 2021

# List of command line arguments for `cargo`.
#
# These cannot be a subcommand, they may only be options.
Copy link
Member

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.

Copy link
Member Author

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.

Copy link
Member

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.

Copy link
Member Author

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:

let res = Command::new(workspace, toolchain.cargo())
.args(&["metadata", "--format-version", "1"])
.cd(source_dir)
.log_output(false)
.run_capture()?;

Copy link
Member Author

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:

let cargo_args = metadata.cargo_args(&cargo_args, &rustdoc_flags_extras);

which is only used for doc coverage and actually generating the documentation.

@jyn514 jyn514 merged commit 803cebf into rust-lang:master Apr 22, 2021
@jyn514 jyn514 deleted the cargo-args branch April 22, 2021 13:56
@jyn514 jyn514 added S-waiting-on-deploy This PR is ready to be merged, but is waiting for an admin to have time to deploy it and removed S-waiting-on-review Status: This pull request has been implemented and needs to be reviewed labels Apr 22, 2021
@syphar syphar removed the S-waiting-on-deploy This PR is ready to be merged, but is waiting for an admin to have time to deploy it label Nov 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-builds Area: Building the documentation for a crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow passing custom args to cargo in builds
3 participants