Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update RFC 2141 #2301

Merged
merged 2 commits into from
Jan 19, 2018
Merged

Update RFC 2141 #2301

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3d95b2
Update RFC 2141 to reflect the implementation
sfackler Jan 18, 2018
203c644
Add a note about bad kind fields
sfackler Jan 18, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions text/2141-alternative-registries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,14 +182,15 @@ A valid registry index meets the following criteria:

```json
{
"dl": "https://my-crates-server.com/api/v1/crates",
"dl": "https://my-crates-server.com/api/v1/crates/{crate}/{version}/download",
"api": "https://my-crates-server.com/",
"allowed-registries": ["https://github.com/rust-lang/crates.io-index", "https://my-intranet:8080/index"]
}
```

The `dl` key is required specifies where Cargo can download the tarballs containing the source
files of the crates listed in the registry.
The `dl` key is required and specifies where Cargo can download the tarballs containing the source
files of the crates listed in the registry. It is templated by the strings `{crate}` and
`{version}` which are replaced with the name and version of the crate to download, respectively.

The `api` key is optional and specifies where Cargo can find the API server that provides the
same API functionality that crates.io does today, such as publishing and searching. Without the
Expand All @@ -205,7 +206,9 @@ A valid registry index meets the following criteria:
- There will be a number of directories in the git repository.
- `1/` - holds files for all crates whose names have one letter.
- `2/` - holds files for all crates whose names have two letters.
- `3/` - holds files for all crates whose names have three letters.
- `3/a` etc - for all crates whose names have three letters, their files will
be in a directory named `3`, then a subdirectory named with the first letter
of their name.
- `aa/aa/` etc - for all crates whose names have four or more letters, their
files will be in a directory named with the first and second letters of
their name, then in a subdirectory named with the third and fourth letters
Expand Down Expand Up @@ -270,7 +273,9 @@ A valid registry index meets the following criteria:
- `default_features`: whether the parent uses the default features of this dependency or not
- `target`: on which target this dependency is needed
- `kind`: can be `normal`, `build`, or `dev` to be a regular dependency, a build-time
dependency, or a development dependency
dependency, or a development dependency. Note: this is a required field, but a small number of
entries exist in the crates.io index with either a missing or null `kind` field due to
implementation bugs.

If a dependency's registry is not specified, Cargo will assume the dependency can be located in the
current registry. By specifying the registry of a dependency in the index, cargo will have the
Expand Down