Skip to content

Commit

Permalink
docs(ref): Deprecate 'package.authors'
Browse files Browse the repository at this point in the history
This was left as a future-possibility in
[RFC #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. #14949, #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 (#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`
  • Loading branch information
epage committed Jan 15, 2025
1 parent d0a9e76 commit bce93d3
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions src/doc/src/reference/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,10 @@ This field is optional and defaults to `0.0.0`. The field is required for publi

### The `authors` field

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

```toml
Expand All @@ -132,13 +132,8 @@ the end of each author entry.
authors = ["Graydon Hoare", "Fnu Lnu <[email protected]>"]
```

This field is only surfaced in package metadata and in the `CARGO_PKG_AUTHORS`
environment variable within `build.rs`. It is not displayed in the [crates.io]
user interface.

> **Warning**: Package manifests cannot be changed once published, so this
> field cannot be changed or removed in already-published versions of a
> package.
This field is surfaced in package metadata and in the `CARGO_PKG_AUTHORS`
environment variable within `build.rs` for backwards compatibility.

### The `edition` field

Expand Down

0 comments on commit bce93d3

Please sign in to comment.