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

Remove readme field from C-METADATA #234

Merged
merged 1 commit into from
Aug 23, 2021
Merged

Conversation

taiki-e
Copy link
Member

@taiki-e taiki-e commented Jan 16, 2021

Since 1.46.0 (rust-lang/cargo#8277), cargo can automatically detect the value of the readme field.

https://doc.rust-lang.org/stable/cargo/reference/manifest.html#the-readme-field

If no value is specified for this field, and a file named README.md, README.txt or README exists in the package root, then the name of that file will be used. You can suppress this behavior by setting this field to false. If the field is set to true, a default value of README.md will be assumed.

@taiki-e
Copy link
Member Author

taiki-e commented Jan 16, 2021

Hmm, considering there are projects that have readme in other than the default location, should this be moved to "optional metadata fields" instead of remove?

Copy link
Member

@dtolnay dtolnay left a comment

Choose a reason for hiding this comment

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

Removing is all right I think.

Thanks!

@dtolnay dtolnay merged commit b2f62d6 into rust-lang:master Aug 23, 2021
@taiki-e taiki-e deleted the c-metadata branch August 23, 2021 03:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants