Skip to content

README.md: simplify notes on Cargo version #619

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

Merged
merged 1 commit into from
Mar 11, 2017
Merged

README.md: simplify notes on Cargo version #619

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 4 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,10 +195,8 @@ categories will be synced from this file.

**DISCLAIMER: The process of setting up a mirror is a work-in-progress and is
likely to change. It is not currently recommended for mission-critical
production use. It also requires a version of cargo newer than 0.13.0-nightly
(f09ef68 2016-08-02); the version of cargo currently on rustc's beta channel
fulfils this requirement and will be shipped with rustc 1.12.0 scheduled to be
released on 2016-09-29.**
production use. It also requires Cargo from Rust distribution 1.12.0 or
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we just say "Cargo 0.13.0" here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. Crates.io users shouldn't have to care which Cargo version they are using. They should just get the latest Rust distribution with rustup and find Cargo in it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough.

later.**

### Current functionality: a read-only, download-API-only mirror

Expand Down Expand Up @@ -249,10 +247,8 @@ to your API server.

### Local Cargo Setup

**NOTE: The following configuration requires a cargo version newer than
0.13.0-nightly (f09ef68 2016-08-02). The version of cargo that comes with rust
1.12.0 fulfils this requirement; this version is currently on the beta channel
and is scheduled to be released on 2016-09-29.**
NOTE: The following configuration requires Cargo from Rust 1.12.0
distribution or later.

In the project where you want to use your mirror, change your `.cargo/config`
to replace the crates.io source to point to your crates index:
Expand All @@ -265,9 +261,4 @@ registry = "https://[host and path to your git server]/crates.io-index"

[source.crates-io]
replace-with = "mirror"
registry = 'https://doesnt-matter-but-must-be-present'
```

Once [rust-lang/cargo#3089](https://github.com/rust-lang/cargo/pull/3089) is
released, it won't be necessary to specify a registry URL for a source being
replaced.