Default values for `readme` if not specified #8277

tverghis · 2020-05-25T07:12:29Z

If the a value for readme is not specified in Cargo.toml, we will now check for the existence of files named README.md, README.txt or README. If one does exist, the name of that file will be defaulted in to the manifest for the project.

This behavior can be suppressed if readme is set to false.

Closes #8133

If the readme field is not specified, assume a default of "README.md" (temporarily). Further, if the readme field is set to "false", then this defaulting behavior is suppressed.

rust-highfive · 2020-05-25T07:12:32Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @Eh2406 (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

joshtriplett · 2020-05-27T21:27:13Z

@rfcbot fcp merge

rfcbot · 2020-05-27T21:27:14Z

Team member @joshtriplett has proposed to merge this. The next step is review by the rest of the tagged team members:

No concerns currently listed.

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

src/cargo/util/toml/mod.rs

crates/cargo-test-support/src/lib.rs

rfcbot · 2020-05-28T15:22:21Z

🔔 This is now entering its final comment period, as per the review above. 🔔

alexcrichton · 2020-05-29T20:07:50Z

src/cargo/util/toml/mod.rs

+        None => default_readme_from_package_root(package_root),
+        Some(value) => match value {
+            StringOrBool::Bool(false) => None,
+            StringOrBool::Bool(true) => default_readme_from_package_root(package_root),


This is an interesting case because readme = true could actually still infer no actual README if the files are missing. Perhaps for now we could just make readme = true an error? Otherwise we probably want to assert that the default readme is indeed present, and None isn't returned in this case.

Sorry for the delay in getting back to this.

What do you think of this approach: Similar to how the build field is handled, if readme = true, we assume a default value of README.md (instead of possibly None, as you pointed out). Then, we can validate that the file really exists while creating the ManifestMetadata, and bail! if the file doesn't exist. This would be more consistent with the behavior of the build field, but I'm not sure how important that is.

Yeah that sounds reasonable to me!

crates/cargo-test-support/src/lib.rs

rfcbot · 2020-06-07T15:25:26Z

The final comment period, with a disposition to merge, as per the review above, is now complete.

As the automated representative of the governance process, I would like to thank the author for their work and everyone else who contributed.

The RFC will be merged soon.

bors · 2020-06-09T13:55:33Z

⌛ Testing commit 58ee013 with merge ec1460a230ec7ef95fc1eea22b60e773c31cf8af...

bors · 2020-06-09T15:55:32Z

💥 Test timed out

alexcrichton · 2020-06-09T20:03:10Z

@bors: retry

bors · 2020-06-09T20:03:19Z

⌛ Testing commit 58ee013 with merge 1ec223e...

bors · 2020-06-09T20:40:45Z

☀️ Test successful - checks-azure
Approved by: alexcrichton
Pushing 1ec223e to master...

Update cargo 15 commits in 40ebd52206e25c7a576ee42c137cc06a745a167a..1ec223effbbbf9fddd3453cdcae3a96a967608eb 2020-06-01 22:35:00 +0000 to 2020-06-09 20:03:14 +0000 - Default values for `readme` if not specified (rust-lang/cargo#8277) - Fix tree completions. (rust-lang/cargo#8342) - Support `{prefix}` and `{lowerprefix}` markers in `config.json` `dl` key (rust-lang/cargo#8267) - Add environment variables to identify the binary and crate name (rust-lang/cargo#8270) - Bump to 0.47.0, update changelog (rust-lang/cargo#8336) - Nits: Remove unneeded mut and loop (rust-lang/cargo#8334) - 1.45 beta backports (rust-lang/cargo#8331) - Better error message when passing in relative path to Workspace::new (rust-lang/cargo#8321) - Don't hash executable filenames on apple platforms. (rust-lang/cargo#8329) - fix clippy warnings (rust-lang/cargo#8324) - Require latest libgit2 to pull in bugfixes (rust-lang/cargo#8320) - Fix an accidental raw access of field (rust-lang/cargo#8319) - Use mem::take to replace with Default values (rust-lang/cargo#8314) - Allow Windows dylibs without dll suffix. (rust-lang/cargo#8310) - Show alias in help message (rust-lang/cargo#8307)

Fix failure with missing readme. #8277 added implicit README support, but it also rejected parsing any manifest where the README was missing. This causes a problem because the README is often missing in many registry packages (for various reasons). This removes the validation at parsing time. Cargo has historically not had hard enforcement at the parsing stage. Whether or not the readme exists has always been enforced during publishing. I have added some extra context to the error message, and added a test to that effect. Fixes #8351

656: Remove readme field from Cargo.toml r=taiki-e a=taiki-e Since 1.46 (rust-lang/cargo#8277), cargo can automatically detect the value of the readme field. Co-authored-by: Taiki Endo <te316e89@gmail.com>

tverghis added 7 commits May 16, 2020 23:24

Set default for readme in Manifest if it's not specified.

b23390b

If the readme field is not specified, assume a default of "README.md" (temporarily). Further, if the readme field is set to "false", then this defaulting behavior is suppressed.

Use one of the default README file names if they exist

3f46046

Use next() instead of nth(0)

f42863c

Refactor

ffe5fbb

Rustfmt

0dfdba6

Add tests

d1fe89e

Rustfmt

dcae5fc

rust-highfive assigned Eh2406 May 25, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 25, 2020

Update documentation for the readme field

54b0432

joshtriplett added the T-cargo Team: Cargo label May 27, 2020

rfcbot added proposed-final-comment-period An FCP proposal has started, but not yet signed off. disposition-merge FCP with intent to merge labels May 27, 2020

alexcrichton reviewed May 28, 2020

View reviewed changes

rfcbot added the final-comment-period FCP — a period for last comments before action is taken label May 28, 2020

rfcbot removed the proposed-final-comment-period An FCP proposal has started, but not yet signed off. label May 28, 2020

tverghis added 4 commits May 28, 2020 10:00

Simplify default_readme_from_package_root

37836e6

Change readme field in TomlProject to StringOrBool

623c2d5

Update tests

05cfcb6

Update Manifest docs

4d8e1ea

tverghis requested a review from alexcrichton May 29, 2020 05:21

alexcrichton reviewed May 29, 2020

View reviewed changes

Move constructor fn for manifest with readme to test file

77c52c2

rfcbot added finished-final-comment-period FCP complete and removed final-comment-period FCP — a period for last comments before action is taken labels Jun 7, 2020

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 9, 2020

bors added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jun 9, 2020

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 9, 2020

bors merged commit 1ec223e into rust-lang:master Jun 9, 2020

ehuss mentioned this pull request Jun 10, 2020

Update cargo rust-lang/rust#73198

Merged

Mark-Simulacrum mentioned this pull request Jun 11, 2020

regression in README parsing #8351

Closed

ehuss mentioned this pull request Jun 11, 2020

Fix failure with missing readme. #8353

Merged

ctm mentioned this pull request Jun 12, 2020

can't deploy ctm/mb2-doc#236

Closed

joshtriplett added the relnotes Release-note worthy label Aug 19, 2020

qryxip mentioned this pull request Sep 16, 2020

Add "commont metadata" to Cargo.toml rust-lang-ja/ac-library-rs#53

Merged

taiki-e mentioned this pull request Jan 16, 2021

Remove readme field from C-METADATA rust-lang/api-guidelines#234

Merged

taiki-e mentioned this pull request Feb 13, 2021

Remove readme field from Cargo.toml crossbeam-rs/crossbeam#656

Merged

JohnTitor mentioned this pull request May 11, 2021

README.md is not found even present rust-lang/crates.io#3575

Closed

memoryruins mentioned this pull request May 17, 2021

Cargo whines about not finding README.md hyperium/hyper#2553

Open

adamgreig mentioned this pull request Jul 25, 2021

Crates.io quality of life improvement cross-rs/cross#563

Closed

ehuss added this to the 1.46.0 milestone Feb 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Default values for `readme` if not specified #8277

Default values for `readme` if not specified #8277

tverghis commented May 25, 2020 •

edited

Loading

rust-highfive commented May 25, 2020

joshtriplett commented May 27, 2020

rfcbot commented May 27, 2020 •

edited by ehuss

Loading

rfcbot commented May 28, 2020

alexcrichton May 29, 2020

tverghis Jun 6, 2020

alexcrichton Jun 8, 2020

rfcbot commented Jun 7, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

alexcrichton commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

Default values for readme if not specified #8277

Default values for readme if not specified #8277

Conversation

tverghis commented May 25, 2020 • edited Loading

rust-highfive commented May 25, 2020

joshtriplett commented May 27, 2020

rfcbot commented May 27, 2020 • edited by ehuss Loading

rfcbot commented May 28, 2020

alexcrichton May 29, 2020

Choose a reason for hiding this comment

tverghis Jun 6, 2020

Choose a reason for hiding this comment

alexcrichton Jun 8, 2020

Choose a reason for hiding this comment

rfcbot commented Jun 7, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

alexcrichton commented Jun 9, 2020

bors commented Jun 9, 2020

bors commented Jun 9, 2020

Default values for `readme` if not specified #8277

Default values for `readme` if not specified #8277

tverghis commented May 25, 2020 •

edited

Loading

rfcbot commented May 27, 2020 •

edited by ehuss

Loading