itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #12040 - epage:doc, r=weihanglo

Browse Source 
docs(ref): Specify 'rust_version' in Index format

See rust-lang/crates.io#6267
This commit is contained in:
bors 2023-04-26 16:32:33 +00:00
commit 284fd3f0f1
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/doc/src/reference/registry-index.md
View File

@ -199,6 +199,9 @@ explaining the format of the entry.
"features2": { "features2": {
"serde": ["dep:serde", "chrono?/serde"] "serde": ["dep:serde", "chrono?/serde"]
} }
// The minimal supported Rust version (optional)
// This must be a valid version requirement without an operator (e.g. no `=`)
"rust_version": "1.60"
} }
``` ```
@ -221,6 +224,9 @@ The JSON objects should not be modified after they are added except for the
> * The publish API includes several other fields, such as `description` and `readme`, which don't appear in the index. > * The publish API includes several other fields, such as `description` and `readme`, which don't appear in the index.
> These are intended to make it easier for a registry to obtain the metadata about the crate to display on a website without needing to extract and parse the `.crate` file. > These are intended to make it easier for a registry to obtain the metadata about the crate to display on a website without needing to extract and parse the `.crate` file.
> This additional information is typically added to a database on the registry server. > This additional information is typically added to a database on the registry server.
> * `rust_version` is not included. If a registry chooses to support this
> field, they must read it from the `Cargo.toml` contained in the `.crate`
> file.
> >
> For [`cargo metadata`], the differences are: > For [`cargo metadata`], the differences are:
> >