Skip to content

Commit 4751e5c

Browse files
borsbors
committed
Auto merge of #9282 - lf-:remove-author, r=ehuss
RFC 3052: Stop including authors field in manifests made by cargo new See rust-lang/rust#83227 ~~This is definitely a draft as there are a couple of tests I'm still working on fixing.~~ One question I ran into while digging through these test failures is that there is a Cargo config option for author name, `cargo-new.name`. Should we keep supporting that? I feel like perhaps we should as the user has specified explicit intent that they want their name in the authors of a manifest as generated by `cargo new`, but it seems weird to support *just* that case. There is likewise an environment variable `CARGO_NAME` that signals similar intent. Should we completely drop the feature of putting in author names, and require people to manually put them in if they wish, or allow these limited cases where the user is specifically instructing *cargo* to do it?
2 parents 39d9413 + 160b7f1 commit 4751e5c

25 files changed

+75
-808
lines changed

‎src/cargo/ops/cargo_new.rs

+6-107
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,9 @@ use crate::util::errors::{CargoResult, CargoResultExt};
33
use crate::util::{existing_vcs_repo, FossilRepo, GitRepo, HgRepo, PijulRepo};
44
use crate::util::{restricted_names, Config};
55
use cargo_util::paths;
6-
use git2::Config as GitConfig;
7-
use git2::Repository as GitRepository;
86
use serde::de;
97
use serde::Deserialize;
108
use std::collections::BTreeMap;
11-
use std::env;
129
use std::fmt;
1310
use std::io::{BufRead, BufReader, ErrorKind};
1411
use std::path::{Path, PathBuf};
@@ -129,8 +126,14 @@ impl NewOptions {
129126

130127
#[derive(Deserialize)]
131128
struct CargoNewConfig {
129+
#[deprecated = "cargo-new no longer supports adding the authors field"]
130+
#[allow(dead_code)]
132131
name: Option<String>,
132+
133+
#[deprecated = "cargo-new no longer supports adding the authors field"]
134+
#[allow(dead_code)]
133135
email: Option<String>,
136+
134137
#[serde(rename = "vcs")]
135138
version_control: Option<VersionControl>,
136139
}
@@ -666,32 +669,6 @@ fn mk(config: &Config, opts: &MkOptions<'_>) -> CargoResult<()> {
666669
init_vcs(path, vcs, config)?;
667670
write_ignore_file(path, &ignore, vcs)?;
668671

669-
let (discovered_name, discovered_email) = discover_author(path);
670-
671-
// "Name <email>" or "Name" or "<email>" or None if neither name nor email is obtained
672-
// cfg takes priority over the discovered ones
673-
let author_name = cfg.name.or(discovered_name);
674-
let author_email = cfg.email.or(discovered_email);
675-
676-
let author = match (author_name, author_email) {
677-
(Some(name), Some(email)) => {
678-
if email.is_empty() {
679-
Some(name)
680-
} else {
681-
Some(format!("{} <{}>", name, email))
682-
}
683-
}
684-
(Some(name), None) => Some(name),
685-
(None, Some(email)) => {
686-
if email.is_empty() {
687-
None
688-
} else {
689-
Some(format!("<{}>", email))
690-
}
691-
}
692-
(None, None) => None,
693-
};
694-
695672
let mut cargotoml_path_specifier = String::new();
696673

697674
// Calculate what `[lib]` and `[[bin]]`s we need to append to `Cargo.toml`.
@@ -730,18 +707,13 @@ path = {}
730707
r#"[package]
731708
name = "{}"
732709
version = "0.1.0"
733-
authors = [{}]
734710
edition = {}
735711
{}
736712
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
737713
738714
[dependencies]
739715
{}"#,
740716
name,
741-
match author {
742-
Some(value) => format!("{}", toml::Value::String(value)),
743-
None => format!(""),
744-
},
745717
match opts.edition {
746718
Some(edition) => toml::Value::String(edition.to_string()),
747719
None => toml::Value::String(Edition::LATEST_STABLE.to_string()),
@@ -811,76 +783,3 @@ mod tests {
811783

812784
Ok(())
813785
}
814-
815-
fn get_environment_variable(variables: &[&str]) -> Option<String> {
816-
variables.iter().filter_map(|var| env::var(var).ok()).next()
817-
}
818-
819-
fn discover_author(path: &Path) -> (Option<String>, Option<String>) {
820-
let git_config = find_git_config(path);
821-
let git_config = git_config.as_ref();
822-
823-
let name_variables = [
824-
"CARGO_NAME",
825-
"GIT_AUTHOR_NAME",
826-
"GIT_COMMITTER_NAME",
827-
"USER",
828-
"USERNAME",
829-
"NAME",
830-
];
831-
let name = get_environment_variable(&name_variables[0..3])
832-
.or_else(|| git_config.and_then(|g| g.get_string("user.name").ok()))
833-
.or_else(|| get_environment_variable(&name_variables[3..]));
834-
835-
let name = name.map(|namestr| namestr.trim().to_string());
836-
837-
let email_variables = [
838-
"CARGO_EMAIL",
839-
"GIT_AUTHOR_EMAIL",
840-
"GIT_COMMITTER_EMAIL",
841-
"EMAIL",
842-
];
843-
let email = get_environment_variable(&email_variables[0..3])
844-
.or_else(|| git_config.and_then(|g| g.get_string("user.email").ok()))
845-
.or_else(|| get_environment_variable(&email_variables[3..]));
846-
847-
let email = email.map(|s| {
848-
let mut s = s.trim();
849-
850-
// In some cases emails will already have <> remove them since they
851-
// are already added when needed.
852-
if s.starts_with('<') && s.ends_with('>') {
853-
s = &s[1..s.len() - 1];
854-
}
855-
856-
s.to_string()
857-
});
858-
859-
(name, email)
860-
}
861-
862-
fn find_git_config(path: &Path) -> Option<GitConfig> {
863-
match env::var("__CARGO_TEST_ROOT") {
864-
Ok(_) => find_tests_git_config(path),
865-
Err(_) => find_real_git_config(path),
866-
}
867-
}
868-
869-
fn find_tests_git_config(path: &Path) -> Option<GitConfig> {
870-
// Don't escape the test sandbox when looking for a git repository.
871-
// NOTE: libgit2 has support to define the path ceiling in
872-
// git_repository_discover, but the git2 bindings do not expose that.
873-
for path in paths::ancestors(path, None) {
874-
if let Ok(repo) = GitRepository::open(path) {
875-
return Some(repo.config().expect("test repo should have valid config"));
876-
}
877-
}
878-
GitConfig::open_default().ok()
879-
}
880-
881-
fn find_real_git_config(path: &Path) -> Option<GitConfig> {
882-
GitRepository::discover(path)
883-
.and_then(|repo| repo.config())
884-
.or_else(|_| GitConfig::open_default())
885-
.ok()
886-
}

‎src/doc/man/cargo-init.md

-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ will be used. If not, then a sample `src/main.rs` file will be created, or
2020
If the directory is not already in a VCS repository, then a new repository
2121
is created (see `--vcs` below).
2222

23-
{{> description-new-authors }}
24-
2523
See {{man "cargo-new" 1}} for a similar command which will create a new package in
2624
a new directory.
2725

‎src/doc/man/cargo-new.md

-2
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ includes a simple template with a `Cargo.toml` manifest, sample source file,
1515
and a VCS ignore file. If the directory is not already in a VCS repository,
1616
then a new repository is created (see `--vcs` below).
1717

18-
{{> description-new-authors }}
19-
2018
See {{man "cargo-init" 1}} for a similar command which will create a new manifest
2119
in an existing directory.
2220

‎src/doc/man/generated_txt/cargo-init.txt

-38
Original file line numberDiff line numberDiff line change
@@ -17,44 +17,6 @@ DESCRIPTION
1717
If the directory is not already in a VCS repository, then a new
1818
repository is created (see --vcs below).
1919

20-
The "authors" field in the manifest is determined from the environment
21-
or configuration settings. A name is required and is determined from
22-
(first match wins):
23-
24-
o cargo-new.name Cargo config value
25-
26-
o CARGO_NAME environment variable
27-
28-
o GIT_AUTHOR_NAME environment variable
29-
30-
o GIT_COMMITTER_NAME environment variable
31-
32-
o user.name git configuration value
33-
34-
o USER environment variable
35-
36-
o USERNAME environment variable
37-
38-
o NAME environment variable
39-
40-
The email address is optional and is determined from:
41-
42-
o cargo-new.email Cargo config value
43-
44-
o CARGO_EMAIL environment variable
45-
46-
o GIT_AUTHOR_EMAIL environment variable
47-
48-
o GIT_COMMITTER_EMAIL environment variable
49-
50-
o user.email git configuration value
51-
52-
o EMAIL environment variable
53-
54-
See the reference
55-
<https://doc.rust-lang.org/cargo/reference/config.html> for more
56-
information about configuration files.
57-
5820
See cargo-new(1) for a similar command which will create a new package
5921
in a new directory.
6022

‎src/doc/man/generated_txt/cargo-new.txt

-38
Original file line numberDiff line numberDiff line change
@@ -12,44 +12,6 @@ DESCRIPTION
1212
source file, and a VCS ignore file. If the directory is not already in a
1313
VCS repository, then a new repository is created (see --vcs below).
1414

15-
The "authors" field in the manifest is determined from the environment
16-
or configuration settings. A name is required and is determined from
17-
(first match wins):
18-
19-
o cargo-new.name Cargo config value
20-
21-
o CARGO_NAME environment variable
22-
23-
o GIT_AUTHOR_NAME environment variable
24-
25-
o GIT_COMMITTER_NAME environment variable
26-
27-
o user.name git configuration value
28-
29-
o USER environment variable
30-
31-
o USERNAME environment variable
32-
33-
o NAME environment variable
34-
35-
The email address is optional and is determined from:
36-
37-
o cargo-new.email Cargo config value
38-
39-
o CARGO_EMAIL environment variable
40-
41-
o GIT_AUTHOR_EMAIL environment variable
42-
43-
o GIT_COMMITTER_EMAIL environment variable
44-
45-
o user.email git configuration value
46-
47-
o EMAIL environment variable
48-
49-
See the reference
50-
<https://doc.rust-lang.org/cargo/reference/config.html> for more
51-
information about configuration files.
52-
5315
See cargo-init(1) for a similar command which will create a new manifest
5416
in an existing directory.
5517

‎src/doc/man/includes/description-new-authors.md

-24
This file was deleted.

‎src/doc/src/commands/cargo-init.md

-26
Original file line numberDiff line numberDiff line change
@@ -20,32 +20,6 @@ will be used. If not, then a sample `src/main.rs` file will be created, or
2020
If the directory is not already in a VCS repository, then a new repository
2121
is created (see `--vcs` below).
2222

23-
The "authors" field in the manifest is determined from the environment or
24-
configuration settings. A name is required and is determined from (first match
25-
wins):
26-
27-
- `cargo-new.name` Cargo config value
28-
- `CARGO_NAME` environment variable
29-
- `GIT_AUTHOR_NAME` environment variable
30-
- `GIT_COMMITTER_NAME` environment variable
31-
- `user.name` git configuration value
32-
- `USER` environment variable
33-
- `USERNAME` environment variable
34-
- `NAME` environment variable
35-
36-
The email address is optional and is determined from:
37-
38-
- `cargo-new.email` Cargo config value
39-
- `CARGO_EMAIL` environment variable
40-
- `GIT_AUTHOR_EMAIL` environment variable
41-
- `GIT_COMMITTER_EMAIL` environment variable
42-
- `user.email` git configuration value
43-
- `EMAIL` environment variable
44-
45-
See [the reference](../reference/config.html) for more information about
46-
configuration files.
47-
48-
4923
See [cargo-new(1)](cargo-new.html) for a similar command which will create a new package in
5024
a new directory.
5125

‎src/doc/src/commands/cargo-new.md

-26
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,6 @@ includes a simple template with a `Cargo.toml` manifest, sample source file,
1515
and a VCS ignore file. If the directory is not already in a VCS repository,
1616
then a new repository is created (see `--vcs` below).
1717

18-
The "authors" field in the manifest is determined from the environment or
19-
configuration settings. A name is required and is determined from (first match
20-
wins):
21-
22-
- `cargo-new.name` Cargo config value
23-
- `CARGO_NAME` environment variable
24-
- `GIT_AUTHOR_NAME` environment variable
25-
- `GIT_COMMITTER_NAME` environment variable
26-
- `user.name` git configuration value
27-
- `USER` environment variable
28-
- `USERNAME` environment variable
29-
- `NAME` environment variable
30-
31-
The email address is optional and is determined from:
32-
33-
- `cargo-new.email` Cargo config value
34-
- `CARGO_EMAIL` environment variable
35-
- `GIT_AUTHOR_EMAIL` environment variable
36-
- `GIT_COMMITTER_EMAIL` environment variable
37-
- `user.email` git configuration value
38-
- `EMAIL` environment variable
39-
40-
See [the reference](../reference/config.html) for more information about
41-
configuration files.
42-
43-
4418
See [cargo-init(1)](cargo-init.html) for a similar command which will create a new manifest
4519
in an existing directory.
4620

‎src/doc/src/getting-started/first-steps.md

-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ This is all we need to get started. First, let’s check out `Cargo.toml`:
3333
[package]
3434
name = "hello_world"
3535
version = "0.1.0"
36-
authors = ["Your Name <[email protected]>"]
3736
edition = "2018"
3837

3938
[dependencies]

‎src/doc/src/guide/cargo-toml-vs-cargo-lock.md

-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ depend on another package:
2727
[package]
2828
name = "hello_world"
2929
version = "0.1.0"
30-
authors = ["Your Name <[email protected]>"]
3130

3231
[dependencies]
3332
rand = { git = "https://github.com/rust-lang-nursery/rand.git" }
@@ -63,7 +62,6 @@ manifest like this:
6362
[package]
6463
name = "hello_world"
6564
version = "0.1.0"
66-
authors = ["Your Name <[email protected]>"]
6765

6866
[dependencies]
6967
rand = { git = "https://github.com/rust-lang-nursery/rand.git" }

‎src/doc/src/guide/creating-a-new-project.md

-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Let’s take a closer look at `Cargo.toml`:
2929
[package]
3030
name = "hello_world"
3131
version = "0.1.0"
32-
authors = ["Your Name <[email protected]>"]
3332
edition = "2018"
3433

3534
[dependencies]

‎src/doc/src/guide/dependencies.md

-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ crates:
3535
[package]
3636
name = "hello_world"
3737
version = "0.1.0"
38-
authors = ["Your Name <[email protected]>"]
3938
edition = "2018"
4039

4140
[dependencies]

0 commit comments

Comments
 (0)