diff --git a/src/doc/book/src/reference/manifest.md b/src/doc/book/src/reference/manifest.md index e6bf03a2c47..48372bb223c 100644 --- a/src/doc/book/src/reference/manifest.md +++ b/src/doc/book/src/reference/manifest.md @@ -168,10 +168,14 @@ keywords = ["...", "..."] # they must match exactly. categories = ["...", "..."] -# This is a string description of the license for this package. Currently -# crates.io will validate the license provided against a whitelist of known -# license identifiers from http://spdx.org/licenses/. Multiple licenses can be -# separated with a `/`. +# This is an SPDX 2.1 license expression for this package. Currently +# crates.io will validate the license provided against a whitelist of +# known license and exception identifiers from the SPDX license list +# 2.4. Parentheses are not currently supported. +# +# Multiple licenses can be separated with a `/`, although that usage +# is deprecated. Instead, use a license expression with AND and OR +# operators to get more explicit semantics. license = "..." # If a project is using a nonstandard license, then this key may be specified in @@ -235,6 +239,11 @@ provide useful information to users of the registry and also influence the search ranking of a crate. It is highly discouraged to omit everything in a published crate. +SPDX 2.1 license expressions are documented +[here][spdx-2.1-license-expressions]. The current version of the +license list is available [here][spdx-license-list], and version 2.4 +is available [here][spdx-license-list-2.4]. + #### The `metadata` table (optional) Cargo by default will warn about unused keys in `Cargo.toml` to assist in @@ -761,3 +770,7 @@ source (e.g. git or a local path). More information about overriding dependencies can be found in the [overriding dependencies][replace] section of the documentation. + +[spdx-2.1-license-expressions]: https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 +[spdx-license-list]: https://spdx.org/licenses/ +[spdx-license-list-2.4]: https://github.com/spdx/license-list-data/tree/v2.4 diff --git a/src/doc/manifest.md b/src/doc/manifest.md index 55a3ae2fca7..dc6b9de17fb 100644 --- a/src/doc/manifest.md +++ b/src/doc/manifest.md @@ -165,10 +165,14 @@ keywords = ["...", "..."] # they must match exactly. categories = ["...", "..."] -# This is a string description of the license for this package. Currently -# crates.io will validate the license provided against a whitelist of known -# license identifiers from http://spdx.org/licenses/. Multiple licenses can be -# separated with a `/`. +# This is an SPDX 2.1 license expression for this package. Currently +# crates.io will validate the license provided against a whitelist of +# known license and exception identifiers from the SPDX license list +# 2.4. Parentheses are not currently supported. +# +# Multiple licenses can be separated with a `/`, although that usage +# is deprecated. Instead, use a license expression with AND and OR +# operators to get more explicit semantics. license = "..." # If a project is using a nonstandard license, then this key may be specified in @@ -234,6 +238,11 @@ provide useful information to users of the registry and also influence the search ranking of a crate. It is highly discouraged to omit everything in a published crate. +SPDX 2.1 license expressions are documented +[here][spdx-2.1-license-expressions]. The current version of the +license list is available [here][spdx-license-list], and version 2.4 +is available [here][spdx-license-list-2.4]. + ## The `metadata` table (optional) Cargo by default will warn about unused keys in `Cargo.toml` to assist in @@ -795,3 +804,7 @@ source (e.g. git or a local path). More information about overriding dependencies can be found in the [overriding dependencies][replace] section of the documentation. + +[spdx-2.1-license-expressions]: https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 +[spdx-license-list]: https://spdx.org/licenses/ +[spdx-license-list-2.4]: https://github.com/spdx/license-list-data/tree/v2.4