Auto merge of #13371 - epage:new-comment, r=weihanglo

fix(new): Print a note, rather than a comment, for more information

### What does this PR try to resolve?

For myself, I find it frustrating when tools add boilerplate that I have to remove after every use.  A `note:` on the command-line is more ephemeral, helping people who need it while not interfering with those that don't.

Fixes #12210

### How should we test and review this PR?

### Additional information

src/cargo/ops/cargo_new.rs

@@ -784,8 +784,7 @@ fn mk(config: &Config, opts: &MkOptions<'_>) -> CargoResult<()> {
         array.push(registry);
         manifest["package"]["publish"] = toml_edit::value(array);
     }
-    let mut dep_table = toml_edit::Table::default();
-    dep_table.decor_mut().set_prefix("\n# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html\n\n");
+    let dep_table = toml_edit::Table::default();
     manifest["dependencies"] = toml_edit::Item::Table(dep_table);
 
     // Calculate what `[lib]` and `[[bin]]`s we need to append to `Cargo.toml`.
@@ -911,6 +910,10 @@ mod tests {
         );
     }
 
+    config.shell().note(
+        "see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html",
+    )?;
+
     Ok(())
 }
 

tests/testsuite/cargo_init/auto_git/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/auto_git/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/bin_already_exists_explicit/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/bin_already_exists_explicit/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/bin_already_exists_explicit_nosrc/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [[bin]]

tests/testsuite/cargo_init/bin_already_exists_explicit_nosrc/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/bin_already_exists_implicit/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/bin_already_exists_implicit/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/bin_already_exists_implicit_namenosrc/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [[bin]]

tests/testsuite/cargo_init/bin_already_exists_implicit_namenosrc/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/bin_already_exists_implicit_namesrc/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [[bin]]

tests/testsuite/cargo_init/bin_already_exists_implicit_namesrc/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/bin_already_exists_implicit_nosrc/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [[bin]]

tests/testsuite/cargo_init/bin_already_exists_implicit_nosrc/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/creates_binary_when_both_binlib_present/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [[bin]]

tests/testsuite/cargo_init/creates_binary_when_both_binlib_present/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/creates_binary_when_instructed_and_has_lib_file/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [[bin]]

tests/testsuite/cargo_init/creates_binary_when_instructed_and_has_lib_file/stderr.log

@@ -1,2 +1,3 @@
     Creating binary (application) package
 warning: file `case.rs` seems to be a library file
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/creates_library_when_instructed_and_has_bin_file/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [lib]

tests/testsuite/cargo_init/creates_library_when_instructed_and_has_bin_file/stderr.log

@@ -1,2 +1,3 @@
     Creating library package
 warning: file `case.rs` seems to be a binary (application) file
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/explicit_bin_with_git/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/explicit_bin_with_git/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/formats_source/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/formats_source/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/fossil_autodetect/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/fossil_autodetect/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/git_autodetect/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "foo"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/git_autodetect/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/git_ignore_exists_no_conflicting_entries/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2015"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/git_ignore_exists_no_conflicting_entries/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/ignores_failure_to_format_source/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/ignores_failure_to_format_source/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/inferred_bin_with_git/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [[bin]]

tests/testsuite/cargo_init/inferred_bin_with_git/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/inferred_lib_with_git/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [lib]

tests/testsuite/cargo_init/inferred_lib_with_git/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/inherit_workspace_package_table/out/crates/foo/Cargo.toml

@@ -16,6 +16,4 @@ publish.workspace = true
 repository.workspace = true
 version.workspace = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/inherit_workspace_package_table/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/lib_already_exists_nosrc/out/Cargo.toml

@@ -3,8 +3,6 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 
 [lib]

tests/testsuite/cargo_init/lib_already_exists_nosrc/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/lib_already_exists_src/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/lib_already_exists_src/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/mercurial_autodetect/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/mercurial_autodetect/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/path_contains_separator/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "testing"
 version = "0.1.0"
 edition = "2015"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/path_contains_separator/stderr.log

@@ -1,3 +1,4 @@
     Creating binary (application) package
 warning: the path `[ROOT]/case/test:ing/.` contains invalid PATH characters (usually `:`, `;`, or `"`)
 It is recommended to use a different name to avoid problems.
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/pijul_autodetect/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/pijul_autodetect/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/simple_bin/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2015"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/simple_bin/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/simple_git/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/simple_git/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/simple_git_ignore_exists/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2015"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/simple_git_ignore_exists/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/simple_hg/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/simple_hg/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/simple_hg_ignore_exists/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/simple_hg_ignore_exists/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/simple_lib/out/Cargo.toml

@@ -3,6 +3,4 @@ name = "case"
 version = "0.1.0"
 edition = "2015"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/simple_lib/stderr.log

@@ -1 +1,2 @@
     Creating library package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/with_argument/out/foo/Cargo.toml

@@ -3,6 +3,4 @@ name = "foo"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/with_argument/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_init/workspace_add_member/out/crates/foo/Cargo.toml

@@ -3,6 +3,4 @@ name = "foo"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_init/workspace_add_member/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_new/add_members_to_workspace_format_previous_items/out/crates/foo/Cargo.toml

@@ -4,6 +4,4 @@ version = "0.1.0"
 edition = "2021"
 authors.workspace = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_new/add_members_to_workspace_format_previous_items/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) `foo` package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_new/add_members_to_workspace_format_sorted/out/crates/foo/Cargo.toml

@@ -3,6 +3,4 @@ name = "foo"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_new/add_members_to_workspace_format_sorted/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) `foo` package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tests/testsuite/cargo_new/add_members_to_workspace_with_absolute_package_path/out/crates/foo/Cargo.toml

@@ -3,6 +3,4 @@ name = "foo"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]

tests/testsuite/cargo_new/add_members_to_workspace_with_absolute_package_path/stderr.log

@@ -1 +1,2 @@
     Creating binary (application) `foo` package
+note: see more `Cargo.toml` keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html