Default Cargo.toml template provide help for completing the metadata #6881

k-nasa · 2019-04-26T14:39:59Z

Descriptio

This is new Cargo.toml example.

[package]
name = "foo"
version = "0.1.0"
authors = ["k-nasa"]
documentation = ""
homepage = ""
repository = ""
readme = ""
categories = []
keywords = []
license = ""
edition = "2018"

[dependencies]

# See more https://doc.rust-lang.org/cargo/reference/manifest.html

Motivation

close: #6845

rust-highfive · 2019-04-26T14:40:13Z

r? @alexcrichton

(rust_highfive has picked a reviewer for you, use r? to override)

alexcrichton · 2019-04-29T14:15:11Z

Thanks for the PR! I would personally prefer to not do this as I feel it clutters up the template with a bit too much noise, but perhaps we could add a comment by default with a link to the reference?

k-nasa · 2019-04-29T14:59:34Z

@alexcrichton I fixed it ! How is it like this?
I'm wondering if I write a link on head or write it tail.

alexcrichton · 2019-04-30T15:17:13Z

Since the intention was to teach about the metadata in the [package] section, perhaps this could be just after that section and look like:

# See more keys and their definitions at https://...

k-nasa · 2019-05-01T00:05:47Z

I changed it. It will be like this.

[package]
name = "hogehoge"
version = "0.1.0"
authors = ["k-nasa <htilcs1115@gmail.com>"]
edition = "2018"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]

alexcrichton · 2019-05-01T15:21:09Z

Ok thanks @k-nasa!

Since this affects the default template which has pretty high visibility I'd like to check in with other folks as well before merging...

@rfcbot fcp merge

rfcbot · 2019-05-01T15:21:10Z

Team member @alexcrichton 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.

ehuss

I think including cargo fmt changes can make it difficult to review PRs. My preference is to only format what the PR touches. Broad-sweeping cargo fmt changes can be done as separate PRs.

ehuss · 2019-05-01T16:35:39Z

tests/testsuite/new.rs

@@ -520,5 +520,13 @@ fn new_with_blank_email() {
        .run();

    let contents = fs::read_to_string(paths::root().join("foo/Cargo.toml")).unwrap();
-    assert!(contents.contains(r#"authors = ["Sen"]"#), contents);
+    assert!(contents.contains(r#"authors = ["Sen"]"#));


Why did this change?

I did not know that it was a custom message. I saw document and understood that this change is unnecessary.

joshtriplett · 2019-05-01T19:03:41Z

I like the "just add a comment" version much better. 👍

I'd prefer to see this rebased so it doesn't add-then-remove the fields in successive commits.

k-nasa · 2019-05-01T21:36:24Z

Succeeded in rebase.
@ehuss @joshtriplett I'm sorry to do miscellaneous things

rfcbot · 2019-05-01T22:13:28Z

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

alexcrichton · 2019-05-02T14:01:02Z

@bors: r+

bors · 2019-05-02T14:01:07Z

📌 Commit f781d2d has been approved by alexcrichton

bors · 2019-05-02T14:01:21Z

⌛ Testing commit f781d2d with merge 7eb9e6c...

Default Cargo.toml template provide help for completing the metadata ## Descriptio This is new Cargo.toml example. ```toml [package] name = "foo" version = "0.1.0" authors = ["k-nasa"] documentation = "" homepage = "" repository = "" readme = "" categories = [] keywords = [] license = "" edition = "2018" [dependencies] # See more https://doc.rust-lang.org/cargo/reference/manifest.html ``` ## Motivation close: #6845

bors · 2019-05-02T14:31:16Z

☀️ Test successful - checks-travis, status-appveyor
Approved by: alexcrichton
Pushing 7eb9e6c to master...

Update cargo 12 commits in beb8fcb5248dc2e6aa488af9613216d5ccb31c6a..759b6161a328db1d4863139e90875308ecd25a75 2019-04-30 23:58:00 +0000 to 2019-05-06 20:47:49 +0000 - Small things (rust-lang/cargo#6910) - Fix skipping over invalid registry packages (rust-lang/cargo#6912) - Fixes rust-lang/cargo#6874 (rust-lang/cargo#6905) - doc: Format examples of version to ease reading (rust-lang/cargo#6907) - fix more typos (codespell) (rust-lang/cargo#6903) - Parse less JSON on null builds (rust-lang/cargo#6880) - chore: Update opener to 0.4 (rust-lang/cargo#6902) - Update documentation for auto-discovery. (rust-lang/cargo#6898) - Update some doc links. (rust-lang/cargo#6897) - Default Cargo.toml template provide help for completing the metadata (rust-lang/cargo#6881) - Run 'cargo fmt --all' (rust-lang/cargo#6896) - Refactor command definition (rust-lang/cargo#6894)

rust-highfive assigned alexcrichton Apr 26, 2019

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 26, 2019

alexcrichton added the T-cargo Team: Cargo label May 1, 2019

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 1, 2019

ehuss reviewed May 1, 2019

View reviewed changes

k-nasa force-pushed the feature_cargo_toml_template branch from 09469e3 to d3cfdaa Compare May 1, 2019 21:29

k-nasa added 2 commits May 2, 2019 06:29

feat: Fill in some fields from the beginning when cargo new

d7ffef7

test: Add reference link test

f781d2d

k-nasa force-pushed the feature_cargo_toml_template branch from d3cfdaa to f781d2d Compare May 1, 2019 21:30

rfcbot added final-comment-period FCP — a period for last comments before action is taken and removed proposed-final-comment-period An FCP proposal has started, but not yet signed off. labels May 1, 2019

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 May 2, 2019

bors merged commit f781d2d into rust-lang:master May 2, 2019

ehuss mentioned this pull request May 7, 2019

Update cargo rust-lang/rust#60596

Merged

rfcbot added finished-final-comment-period FCP complete and removed final-comment-period FCP — a period for last comments before action is taken labels May 11, 2019

ehuss mentioned this pull request Jun 14, 2019

Category slugs assignment is not user friendly. #7035

Closed

ehuss added this to the 1.36.0 milestone Feb 6, 2022

ehuss mentioned this pull request Oct 7, 2023

cargo new: add a [profile.release] section with commented out suggestions #12769

Closed

This was referenced Oct 11, 2023

cargo new: create a README #3506

Closed

Consider linking to the Cargo.lock FAQ in the .gitignore #12558

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Default Cargo.toml template provide help for completing the metadata #6881

Default Cargo.toml template provide help for completing the metadata #6881

k-nasa commented Apr 26, 2019

rust-highfive commented Apr 26, 2019

alexcrichton commented Apr 29, 2019

k-nasa commented Apr 29, 2019

alexcrichton commented Apr 30, 2019

k-nasa commented May 1, 2019

alexcrichton commented May 1, 2019

rfcbot commented May 1, 2019 •

edited by nrc

Loading

ehuss left a comment

ehuss May 1, 2019

k-nasa May 1, 2019

joshtriplett commented May 1, 2019 •

edited

Loading

k-nasa commented May 1, 2019

rfcbot commented May 1, 2019

alexcrichton commented May 2, 2019

bors commented May 2, 2019

bors commented May 2, 2019

bors commented May 2, 2019

Default Cargo.toml template provide help for completing the metadata #6881

Default Cargo.toml template provide help for completing the metadata #6881

Conversation

k-nasa commented Apr 26, 2019

Descriptio

Motivation

rust-highfive commented Apr 26, 2019

alexcrichton commented Apr 29, 2019

k-nasa commented Apr 29, 2019

alexcrichton commented Apr 30, 2019

k-nasa commented May 1, 2019

alexcrichton commented May 1, 2019

rfcbot commented May 1, 2019 • edited by nrc Loading

ehuss left a comment

Choose a reason for hiding this comment

ehuss May 1, 2019

Choose a reason for hiding this comment

k-nasa May 1, 2019

Choose a reason for hiding this comment

joshtriplett commented May 1, 2019 • edited Loading

k-nasa commented May 1, 2019

rfcbot commented May 1, 2019

alexcrichton commented May 2, 2019

bors commented May 2, 2019

bors commented May 2, 2019

bors commented May 2, 2019

rfcbot commented May 1, 2019 •

edited by nrc

Loading

joshtriplett commented May 1, 2019 •

edited

Loading