Skip to content

Commit 63717bf

Browse files
lf-ehuss
authored andcommitted
Update docs for default absent authors field
1 parent 47347de commit 63717bf

File tree

12 files changed

+0
-311
lines changed

12 files changed

+0
-311
lines changed

src/doc/man/cargo-init.md

Lines changed: 0 additions & 2 deletions
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

Lines changed: 0 additions & 2 deletions
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

Lines changed: 0 additions & 38 deletions
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

Lines changed: 0 additions & 38 deletions
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

Lines changed: 0 additions & 24 deletions
This file was deleted.

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

Lines changed: 0 additions & 26 deletions
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

Lines changed: 0 additions & 26 deletions
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

Lines changed: 0 additions & 1 deletion
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/reference/config.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ dep-info-basedir = "…" # path for the base directory for targets in dep
6868
pipelining = true # rustc pipelining
6969

7070
[cargo-new]
71-
name = "Your Name" # name to use in `authors` field
72-
email = "[email protected]" # email address to use in `authors` field
7371
vcs = "none" # VCS to use ('git', 'hg', 'pijul', 'fossil', 'none')
7472

7573
[http]
@@ -401,27 +399,6 @@ schedule overlapping invocations of `rustc` in parallel when possible.
401399

402400
The `[cargo-new]` table defines defaults for the [`cargo new`] command.
403401

404-
##### `cargo-new.name`
405-
* Type: string
406-
* Default: from environment
407-
* Environment: `CARGO_NAME` or `CARGO_CARGO_NEW_NAME`
408-
409-
Defines the name to use in the `authors` field when creating a new
410-
`Cargo.toml` file. If not specified in the config, Cargo searches the
411-
environment or your `git` configuration as described in the [`cargo new`]
412-
documentation.
413-
414-
##### `cargo-new.email`
415-
* Type: string
416-
* Default: from environment
417-
* Environment: `CARGO_EMAIL` or `CARGO_CARGO_NEW_EMAIL`
418-
419-
Defines the email address used in the `authors` field when creating a new
420-
`Cargo.toml` file. If not specified in the config, Cargo searches the
421-
environment or your `git` configuration as described in the [`cargo new`]
422-
documentation. The `email` value may be set to an empty string to prevent
423-
Cargo from placing an address in the authors field.
424-
425402
##### `cargo-new.vcs`
426403
* Type: string
427404
* Default: "git" or "none"

src/doc/src/reference/publishing.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ Check out the [metadata you can specify](manifest.md) in `Cargo.toml` to
3434
ensure your crate can be discovered more easily! Before publishing, make sure
3535
you have filled out the following fields:
3636

37-
- [`authors`]
3837
- [`license` or `license-file`]
3938
- [`description`]
4039
- [`homepage`]

0 commit comments

Comments
 (0)