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.

Sign up for GitHub

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

Jump to bottom

Default values for readme if not specified #8133

Closed
joshtriplett opened this issue Apr 18, 2020 · 3 comments · Fixed by #8277
Closed

Default values for readme if not specified #8133

joshtriplett opened this issue Apr 18, 2020 · 3 comments · Fixed by #8277
Labels
A-manifest Area: Cargo.toml issues C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted`

Comments

@joshtriplett
Copy link
Member

Many packages specify readme = "README.md". Could we automatically detect README.md,README, or README.txt, and use those as the values of readme if the files exist and the manifest key doesn't, just as we do for build? That would avoid the need to specify it in most common cases.
@joshtriplett joshtriplett added the C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted` label Apr 18, 2020
@joshtriplett
Copy link
Member Author

We discussed this in the cargo meeting, and agreed we should do this.

Also, readme = false should disable this behavior, just as build = false disables the default of using build.rs if it exists.

@ehuss ehuss added the A-manifest Area: Cargo.toml issues label Apr 29, 2020
@tverghis
Copy link
Contributor

I'd like to take a stab at this!

@ehuss
Copy link
Contributor

ehuss commented May 16, 2020

Thanks @tverghis! Let us know if you have any questions.

@tverghis tverghis mentioned this issue May 25, 2020
Merged
@bors bors closed this as completed in 1ec223e Jun 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-manifest Area: Cargo.toml issues C-feature-request Category: proposal for a feature. Before PR, ping rust-lang/cargo if this is not `Feature accepted`
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Default values for readme if not specified tverghis/cargo
3 participants
@ehuss @joshtriplett @tverghis