RFC 3052: Stop including authors field in manifests made by cargo new

src/cargo/ops/cargo_new.rs

@@ -3,12 +3,9 @@ use crate::util::errors::{CargoResult, CargoResultExt};
 use crate::util::{existing_vcs_repo, FossilRepo, GitRepo, HgRepo, PijulRepo};
 use crate::util::{restricted_names, Config};
 use cargo_util::paths;
-use git2::Config as GitConfig;
-use git2::Repository as GitRepository;
 use serde::de;
 use serde::Deserialize;
 use std::collections::BTreeMap;
-use std::env;
 use std::fmt;
 use std::io::{BufRead, BufReader, ErrorKind};
 use std::path::{Path, PathBuf};
@@ -129,8 +126,14 @@ impl NewOptions {
 
 #[derive(Deserialize)]
 struct CargoNewConfig {
+    #[deprecated = "cargo-new no longer supports adding the authors field"]
+    #[allow(dead_code)]
     name: Option<String>,
+
+    #[deprecated = "cargo-new no longer supports adding the authors field"]
+    #[allow(dead_code)]
     email: Option<String>,
+
     #[serde(rename = "vcs")]
     version_control: Option<VersionControl>,
 }
@@ -666,32 +669,6 @@ fn mk(config: &Config, opts: &MkOptions<'_>) -> CargoResult<()> {
     init_vcs(path, vcs, config)?;
     write_ignore_file(path, &ignore, vcs)?;
 
-    let (discovered_name, discovered_email) = discover_author(path);
-
-    // "Name <email>" or "Name" or "<email>" or None if neither name nor email is obtained
-    // cfg takes priority over the discovered ones
-    let author_name = cfg.name.or(discovered_name);
-    let author_email = cfg.email.or(discovered_email);
-
-    let author = match (author_name, author_email) {
-        (Some(name), Some(email)) => {
-            if email.is_empty() {
-                Some(name)
-            } else {
-                Some(format!("{} <{}>", name, email))
-            }
-        }
-        (Some(name), None) => Some(name),
-        (None, Some(email)) => {
-            if email.is_empty() {
-                None
-            } else {
-                Some(format!("<{}>", email))
-            }
-        }
-        (None, None) => None,
-    };
-
     let mut cargotoml_path_specifier = String::new();
 
     // Calculate what `[lib]` and `[[bin]]`s we need to append to `Cargo.toml`.
@@ -730,18 +707,13 @@ path = {}
             r#"[package]
 name = "{}"
 version = "0.1.0"
-authors = [{}]
 edition = {}
 {}
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 {}"#,
             name,
-            match author {
-                Some(value) => format!("{}", toml::Value::String(value)),
-                None => format!(""),
-            },
             match opts.edition {
                 Some(edition) => toml::Value::String(edition.to_string()),
                 None => toml::Value::String(Edition::LATEST_STABLE.to_string()),
@@ -811,76 +783,3 @@ mod tests {
 
     Ok(())
 }
-
-fn get_environment_variable(variables: &[&str]) -> Option<String> {
-    variables.iter().filter_map(|var| env::var(var).ok()).next()
-}
-
-fn discover_author(path: &Path) -> (Option<String>, Option<String>) {
-    let git_config = find_git_config(path);
-    let git_config = git_config.as_ref();
-
-    let name_variables = [
-        "CARGO_NAME",
-        "GIT_AUTHOR_NAME",
-        "GIT_COMMITTER_NAME",
-        "USER",
-        "USERNAME",
-        "NAME",
-    ];
-    let name = get_environment_variable(&name_variables[0..3])
-        .or_else(|| git_config.and_then(|g| g.get_string("user.name").ok()))
-        .or_else(|| get_environment_variable(&name_variables[3..]));
-
-    let name = name.map(|namestr| namestr.trim().to_string());
-
-    let email_variables = [
-        "CARGO_EMAIL",
-        "GIT_AUTHOR_EMAIL",
-        "GIT_COMMITTER_EMAIL",
-        "EMAIL",
-    ];
-    let email = get_environment_variable(&email_variables[0..3])
-        .or_else(|| git_config.and_then(|g| g.get_string("user.email").ok()))
-        .or_else(|| get_environment_variable(&email_variables[3..]));
-
-    let email = email.map(|s| {
-        let mut s = s.trim();
-
-        // In some cases emails will already have <> remove them since they
-        // are already added when needed.
-        if s.starts_with('<') && s.ends_with('>') {
-            s = &s[1..s.len() - 1];
-        }
-
-        s.to_string()
-    });
-
-    (name, email)
-}
-
-fn find_git_config(path: &Path) -> Option<GitConfig> {
-    match env::var("__CARGO_TEST_ROOT") {
-        Ok(_) => find_tests_git_config(path),
-        Err(_) => find_real_git_config(path),
-    }
-}
-
-fn find_tests_git_config(path: &Path) -> Option<GitConfig> {
-    // Don't escape the test sandbox when looking for a git repository.
-    // NOTE: libgit2 has support to define the path ceiling in
-    // git_repository_discover, but the git2 bindings do not expose that.
-    for path in paths::ancestors(path, None) {
-        if let Ok(repo) = GitRepository::open(path) {
-            return Some(repo.config().expect("test repo should have valid config"));
-        }
-    }
-    GitConfig::open_default().ok()
-}
-
-fn find_real_git_config(path: &Path) -> Option<GitConfig> {
-    GitRepository::discover(path)
-        .and_then(|repo| repo.config())
-        .or_else(|_| GitConfig::open_default())
-        .ok()
-}

src/doc/man/cargo-init.md

@@ -20,8 +20,6 @@ will be used. If not, then a sample `src/main.rs` file will be created, or
 If the directory is not already in a VCS repository, then a new repository
 is created (see `--vcs` below).
 
-{{> description-new-authors }}
-
 See {{man "cargo-new" 1}} for a similar command which will create a new package in
 a new directory.
 

src/doc/man/cargo-new.md

@@ -15,8 +15,6 @@ includes a simple template with a `Cargo.toml` manifest, sample source file,
 and a VCS ignore file. If the directory is not already in a VCS repository,
 then a new repository is created (see `--vcs` below).
 
-{{> description-new-authors }}
-
 See {{man "cargo-init" 1}} for a similar command which will create a new manifest
 in an existing directory.
 

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

@@ -17,44 +17,6 @@ DESCRIPTION
        If the directory is not already in a VCS repository, then a new
        repository is created (see --vcs below).
 
-       The "authors" field in the manifest is determined from the environment
-       or configuration settings. A name is required and is determined from
-       (first match wins):
-
-       o  cargo-new.name Cargo config value
-
-       o  CARGO_NAME environment variable
-
-       o  GIT_AUTHOR_NAME environment variable
-
-       o  GIT_COMMITTER_NAME environment variable
-
-       o  user.name git configuration value
-
-       o  USER environment variable
-
-       o  USERNAME environment variable
-
-       o  NAME environment variable
-
-       The email address is optional and is determined from:
-
-       o  cargo-new.email Cargo config value
-
-       o  CARGO_EMAIL environment variable
-
-       o  GIT_AUTHOR_EMAIL environment variable
-
-       o  GIT_COMMITTER_EMAIL environment variable
-
-       o  user.email git configuration value
-
-       o  EMAIL environment variable
-
-       See the reference
-       <https://doc.rust-lang.org/cargo/reference/config.html> for more
-       information about configuration files.
-
        See cargo-new(1) for a similar command which will create a new package
        in a new directory.
 

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

@@ -12,44 +12,6 @@ DESCRIPTION
        source file, and a VCS ignore file. If the directory is not already in a
        VCS repository, then a new repository is created (see --vcs below).
 
-       The "authors" field in the manifest is determined from the environment
-       or configuration settings. A name is required and is determined from
-       (first match wins):
-
-       o  cargo-new.name Cargo config value
-
-       o  CARGO_NAME environment variable
-
-       o  GIT_AUTHOR_NAME environment variable
-
-       o  GIT_COMMITTER_NAME environment variable
-
-       o  user.name git configuration value
-
-       o  USER environment variable
-
-       o  USERNAME environment variable
-
-       o  NAME environment variable
-
-       The email address is optional and is determined from:
-
-       o  cargo-new.email Cargo config value
-
-       o  CARGO_EMAIL environment variable
-
-       o  GIT_AUTHOR_EMAIL environment variable
-
-       o  GIT_COMMITTER_EMAIL environment variable
-
-       o  user.email git configuration value
-
-       o  EMAIL environment variable
-
-       See the reference
-       <https://doc.rust-lang.org/cargo/reference/config.html> for more
-       information about configuration files.
-
        See cargo-init(1) for a similar command which will create a new manifest
        in an existing directory.
 

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

@@ -20,32 +20,6 @@ will be used. If not, then a sample `src/main.rs` file will be created, or
 If the directory is not already in a VCS repository, then a new repository
 is created (see `--vcs` below).
 
-The "authors" field in the manifest is determined from the environment or
-configuration settings. A name is required and is determined from (first match
-wins):
-
-- `cargo-new.name` Cargo config value
-- `CARGO_NAME` environment variable
-- `GIT_AUTHOR_NAME` environment variable
-- `GIT_COMMITTER_NAME` environment variable
-- `user.name` git configuration value
-- `USER` environment variable
-- `USERNAME` environment variable
-- `NAME` environment variable
-
-The email address is optional and is determined from:
-
-- `cargo-new.email` Cargo config value
-- `CARGO_EMAIL` environment variable
-- `GIT_AUTHOR_EMAIL` environment variable
-- `GIT_COMMITTER_EMAIL` environment variable
-- `user.email` git configuration value
-- `EMAIL` environment variable
-
-See [the reference](../reference/config.html) for more information about
-configuration files.
-
-
 See [cargo-new(1)](cargo-new.html) for a similar command which will create a new package in
 a new directory.
 

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

@@ -15,32 +15,6 @@ includes a simple template with a `Cargo.toml` manifest, sample source file,
 and a VCS ignore file. If the directory is not already in a VCS repository,
 then a new repository is created (see `--vcs` below).
 
-The "authors" field in the manifest is determined from the environment or
-configuration settings. A name is required and is determined from (first match
-wins):
-
-- `cargo-new.name` Cargo config value
-- `CARGO_NAME` environment variable
-- `GIT_AUTHOR_NAME` environment variable
-- `GIT_COMMITTER_NAME` environment variable
-- `user.name` git configuration value
-- `USER` environment variable
-- `USERNAME` environment variable
-- `NAME` environment variable
-
-The email address is optional and is determined from:
-
-- `cargo-new.email` Cargo config value
-- `CARGO_EMAIL` environment variable
-- `GIT_AUTHOR_EMAIL` environment variable
-- `GIT_COMMITTER_EMAIL` environment variable
-- `user.email` git configuration value
-- `EMAIL` environment variable
-
-See [the reference](../reference/config.html) for more information about
-configuration files.
-
-
 See [cargo-init(1)](cargo-init.html) for a similar command which will create a new manifest
 in an existing directory.
 

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

@@ -33,7 +33,6 @@ This is all we need to get started. First, let’s check out `Cargo.toml`:
 [package]
 name = "hello_world"
 version = "0.1.0"
-authors = ["Your Name <you@example.com>"]
 edition = "2018"
 
 [dependencies]

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

@@ -27,7 +27,6 @@ depend on another package:
 [package]
 name = "hello_world"
 version = "0.1.0"
-authors = ["Your Name <you@example.com>"]
 
 [dependencies]
 rand = { git = "https://github.com/rust-lang-nursery/rand.git" }
@@ -63,7 +62,6 @@ manifest like this:
 [package]
 name = "hello_world"
 version = "0.1.0"
-authors = ["Your Name <you@example.com>"]
 
 [dependencies]
 rand = { git = "https://github.com/rust-lang-nursery/rand.git" }

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

@@ -29,7 +29,6 @@ Let’s take a closer look at `Cargo.toml`:
 [package]
 name = "hello_world"
 version = "0.1.0"
-authors = ["Your Name <you@example.com>"]
 edition = "2018"
 
 [dependencies]

src/doc/src/guide/dependencies.md

@@ -35,7 +35,6 @@ crates:
 [package]
 name = "hello_world"
 version = "0.1.0"
-authors = ["Your Name <you@example.com>"]
 edition = "2018"
 
 [dependencies]