Reduce references to `[project]` within cargo #11135

Muscraft · 2022-09-23T02:30:25Z

There was an issue (#11129) with [project] being put in the docs but nothing else stating what [project] is. This was an oversight by me when writing the docs as [project] is still supported in cargo. Back in 2014 [project] was renamed to [package], since then it has kinda sat as something that exists and is supported but not really. I brought this up in a zulip thread, and it was suggested that we could show a warning when [project] is used in a manifest of a top-level crate.

To go slightly further than this I tried to change as many references from [project] to [package] as possible. This should hopefully help with confusion between [project] and [package] in the future.

This PR also includes a cherry-picked commit from #11131 as it was having issues with bors and fits well with the changes that are being made in this PR.

This should ideally be reviewed commit by commit

rust-highfive · 2022-09-23T02:30:29Z

r? @epage

(rust-highfive has picked a reviewer for you, use r? to override)

src/cargo/util/toml/mod.rs

epage · 2022-09-23T13:53:35Z

r? @weihanglo

weihanglo

Thank you. Only some little stuff left.

tests/testsuite/check.rs

src/cargo/util/toml/mod.rs

This was accidentially overlooked when writing the documentation. Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

weihanglo

Looks good to me. Thanks!

weihanglo · 2022-09-27T09:26:12Z

@bors r+

bors · 2022-09-27T09:26:14Z

📌 Commit 8625d72 has been approved by weihanglo

It is now in the queue for this repository.

bors · 2022-09-27T09:26:30Z

⌛ Testing commit 8625d72 with merge 928561a...

bors · 2022-09-27T10:11:43Z

☀️ Test successful - checks-actions
Approved by: weihanglo
Pushing 928561a to master...

22 commits in 73ba3f35e0205844418260722c11602113179c4a..f5fed93ba24607980647962c59863bbabb03ce14 2022-09-18 06:38:16 +0000 to 2022-09-27 12:03:57 +0000 - build-scripts.md: Use em dash consistently. (rust-lang/cargo#11150) - Indicate how Cargo locates the manifest (rust-lang/cargo#10770) - Reduce references to `[project]` within cargo (rust-lang/cargo#11135) - Iteratively construct target cfg (rust-lang/cargo#11114) - update comment about `CARGO_BIN_EXE_` (rust-lang/cargo#11146) - Call out that not all config values can be set via env vars (rust-lang/cargo#11139) - Bump to 0.67.0, update changelog (rust-lang/cargo#11137) - ci: update toolchain for building api doc (rust-lang/cargo#11134) - Http publish not noop (rust-lang/cargo#11111) - Improve errors for TOML fields that support workspace inheritance (rust-lang/cargo#11113) - switch to `std::task::ready!()` where possible (rust-lang/cargo#11130) - Report cmd aliasing failure with more contexts (rust-lang/cargo#11087) - minor: remove unused mut (rust-lang/cargo#11127) - fix(cli): Forward non-UTF8 arguments to external subcommands (rust-lang/cargo#11118) - This change adds an example to the authors attribute in the manifest. (rust-lang/cargo#10938) - Add support for relative git submodule paths (rust-lang/cargo#11106) - make unknown features on `cargo add` more discoverable (rust-lang/cargo#11098) - Unlink old final artifacts before compilation (rust-lang/cargo#11122) - refactor(cli): Prepare for clap v4 (rust-lang/cargo#11116) - fix(cli): Error trailing args rather than ignore (rust-lang/cargo#11119) - Add a minor clarification (rust-lang/cargo#11093) - doc(changelog): mention CVE fixes (rust-lang/cargo#11104)

Update cargo 22 commits in 73ba3f35e0205844418260722c11602113179c4a..f5fed93ba24607980647962c59863bbabb03ce14 2022-09-18 06:38:16 +0000 to 2022-09-27 12:03:57 +0000 - build-scripts.md: Use em dash consistently. (rust-lang/cargo#11150) - Indicate how Cargo locates the manifest (rust-lang/cargo#10770) - Reduce references to `[project]` within cargo (rust-lang/cargo#11135) - Iteratively construct target cfg (rust-lang/cargo#11114) - update comment about `CARGO_BIN_EXE_` (rust-lang/cargo#11146) - Call out that not all config values can be set via env vars (rust-lang/cargo#11139) - Bump to 0.67.0, update changelog (rust-lang/cargo#11137) - ci: update toolchain for building api doc (rust-lang/cargo#11134) - Http publish not noop (rust-lang/cargo#11111) - Improve errors for TOML fields that support workspace inheritance (rust-lang/cargo#11113) - switch to `std::task::ready!()` where possible (rust-lang/cargo#11130) - Report cmd aliasing failure with more contexts (rust-lang/cargo#11087) - minor: remove unused mut (rust-lang/cargo#11127) - fix(cli): Forward non-UTF8 arguments to external subcommands (rust-lang/cargo#11118) - This change adds an example to the authors attribute in the manifest. (rust-lang/cargo#10938) - Add support for relative git submodule paths (rust-lang/cargo#11106) - make unknown features on `cargo add` more discoverable (rust-lang/cargo#11098) - Unlink old final artifacts before compilation (rust-lang/cargo#11122) - refactor(cli): Prepare for clap v4 (rust-lang/cargo#11116) - fix(cli): Error trailing args rather than ignore (rust-lang/cargo#11119) - Add a minor clarification (rust-lang/cargo#11093) - doc(changelog): mention CVE fixes (rust-lang/cargo#11104)

fix(toml): Error on `[project]` in Edition 2024 ### What does this PR try to resolve? `[package]` was added in 86b2a2a in the pre-1.0 days but `[project]` was never removed nor did we warn on its use until recently in #11135. So likely we can't remove it completely but we can remove it in Edition 2024+. This includes `cargo fix` support which is hard coded directly into the `cargo fix` command. This is part of - #13629 - rust-lang/rust#123754 While we haven't signed off on everything in #13629, I figured this (and a couple other changes) are not very controversial. ### How should we test and review this PR? Per commit. Tests are added to show the behavior changes, including in `cargo fix`. ### Additional information

rust-highfive assigned epage Sep 23, 2022

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 23, 2022

weihanglo reviewed Sep 23, 2022

View reviewed changes

src/cargo/util/toml/mod.rs Outdated Show resolved Hide resolved

src/cargo/util/toml/mod.rs Outdated Show resolved Hide resolved

weihanglo added A-diagnostics Area: Error and warning messages generated by Cargo itself. A-manifest Area: Cargo.toml issues labels Sep 23, 2022

rust-highfive assigned weihanglo and unassigned epage Sep 23, 2022

Muscraft force-pushed the remove-ref-to-project branch from f991944 to f784e7a Compare September 23, 2022 15:21

weihanglo reviewed Sep 23, 2022

View reviewed changes

tests/testsuite/check.rs Outdated Show resolved Hide resolved

tests/testsuite/check.rs Outdated Show resolved Hide resolved

src/cargo/util/toml/mod.rs Outdated Show resolved Hide resolved

matthiasbeyer and others added 4 commits September 26, 2022 09:51

Fix: "project" should be "package"

281113b

This was accidentially overlooked when writing the documentation. Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

refactor(testsuite): Replace [project] with [package]

ab18bd4

refactor: Rename TomlProject to TomlPackage

b7ca85d

refactor: Reduce use of project in util/mod.rs

1850549

Muscraft force-pushed the remove-ref-to-project branch from f784e7a to df9c125 Compare September 26, 2022 16:14

Muscraft added 2 commits September 26, 2022 10:32

fix(cargo): Add a warning on package and project in the same Cargo.toml

cabee4f

fix(cargo): Add a warning on [project] table being used in a manifest

8625d72

Muscraft force-pushed the remove-ref-to-project branch from df9c125 to 8625d72 Compare September 26, 2022 16:33

weihanglo approved these changes Sep 27, 2022

View reviewed changes

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 Sep 27, 2022

bors merged commit 928561a into rust-lang:master Sep 27, 2022

weihanglo mentioned this pull request Sep 27, 2022

Fix: "project" should be "package" #11131

Closed

Muscraft deleted the remove-ref-to-project branch September 27, 2022 12:52

weihanglo mentioned this pull request Sep 27, 2022

Update cargo rust-lang/rust#102365

Merged

ehuss mentioned this pull request Sep 30, 2022

Implement RFC 3289: source replacement ambiguity #10907

Merged

ehuss added this to the 1.66.0 milestone Oct 1, 2022

weihanglo mentioned this pull request Mar 22, 2024

Next step for deprecations in Cargo #13629

Open

13 tasks

epage mentioned this pull request Apr 12, 2024

fix(toml): Error on [project] in Edition 2024 #13747

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Reduce references to `[project]` within cargo #11135

Reduce references to `[project]` within cargo #11135

Uh oh!

Muscraft commented Sep 23, 2022 •

edited

Loading

Uh oh!

rust-highfive commented Sep 23, 2022

Uh oh!

Uh oh!

Uh oh!

epage commented Sep 23, 2022

Uh oh!

weihanglo left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weihanglo left a comment

Uh oh!

weihanglo commented Sep 27, 2022

Uh oh!

bors commented Sep 27, 2022

Uh oh!

bors commented Sep 27, 2022

Uh oh!

bors commented Sep 27, 2022

Uh oh!

Uh oh!

Reduce references to [project] within cargo #11135

Reduce references to [project] within cargo #11135

Uh oh!

Conversation

Muscraft commented Sep 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rust-highfive commented Sep 23, 2022

Uh oh!

Uh oh!

Uh oh!

epage commented Sep 23, 2022

Uh oh!

weihanglo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weihanglo left a comment

Choose a reason for hiding this comment

Uh oh!

weihanglo commented Sep 27, 2022

Uh oh!

bors commented Sep 27, 2022

Uh oh!

bors commented Sep 27, 2022

Uh oh!

bors commented Sep 27, 2022

Uh oh!

Uh oh!

Reduce references to `[project]` within cargo #11135

Reduce references to `[project]` within cargo #11135

Muscraft commented Sep 23, 2022 •

edited

Loading