Skip to content

Commit 32d6e9d

Browse files
committed
docs(ref): Deprecate 'package.authors'
This was left as a future-possibility in [RFC rust-lang#3052](https://rust-lang.github.io/rfcs/3052-optional-authors-field.html). Without a clear role for this field within Cargo/crates.io, there seems little reason to actively support it (e.g. rust-lang#14949, rust-lang#15027), including working through feature requests. I see the potential for having some fields with more specific roles (where to go for support, where to go for disclosing vulnerabilities, etc) but even these run into the mutable data problem of `authors`. Users can always manage metadata for their own purposes through `package.metadata`. The RFC called out clap as an example of something that uses this. Clap no longer does by default but users can opt-in through a `help_template`. For now, this notes the status in the documentation. When we have[user control over Cargo lint (rust-lang#12235) (and figure out namespacing with lints that overlap with Rust), we can give a warning on this. Based on feedback from users, we can evaluate removing this field in a future edition. We may want to consider doing similar for `badges`
1 parent 1a18d72 commit 32d6e9d

File tree

1 file changed

+5
-10
lines changed

1 file changed

+5
-10
lines changed

src/doc/src/reference/manifest.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,10 @@ This field is optional and defaults to `0.0.0`. The field is required for publi
120120

121121
### The `authors` field
122122

123+
> **Warning**: This field is deprecated
124+
123125
The optional `authors` field lists in an array the people or organizations that are considered
124-
the "authors" of the package. The exact meaning is open to interpretation --- it
125-
may list the original or primary authors, current maintainers, or owners of the
126-
package. An optional email address may be included within angled brackets at
126+
the "authors" of the package. An optional email address may be included within angled brackets at
127127
the end of each author entry.
128128

129129
```toml
@@ -132,13 +132,8 @@ the end of each author entry.
132132
authors = ["Graydon Hoare", "Fnu Lnu <no-reply@rust-lang.org>"]
133133
```
134134

135-
This field is only surfaced in package metadata and in the `CARGO_PKG_AUTHORS`
136-
environment variable within `build.rs`. It is not displayed in the [crates.io]
137-
user interface.
138-
139-
> **Warning**: Package manifests cannot be changed once published, so this
140-
> field cannot be changed or removed in already-published versions of a
141-
> package.
135+
This field is surfaced in package metadata and in the `CARGO_PKG_AUTHORS`
136+
environment variable within `build.rs` for backwards compatibility.
142137

143138
### The `edition` field
144139

0 commit comments

Comments
 (0)