Skip to content

Replace rust_repositories with rust_register_toolchains in docs #1237

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 4 commits into from
Mar 30, 2022
Merged

Replace rust_repositories with rust_register_toolchains in docs #1237

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
71f07e2
Replace `rust_repositories` with `rust_register_toolchains` in docs
UebelAndre Mar 30, 2022
afaf398
Merge branch 'main' into docs
UebelAndre Mar 30, 2022
c126224
Merge branch 'main' into docs
UebelAndre Mar 30, 2022
98797ac
Merge branch 'main' into docs
UebelAndre Mar 30, 2022
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
8 changes: 4 additions & 4 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,22 +62,22 @@ You can also browse the [full API in one page](flatten.md).

## Specifying Rust version

To build with a particular version of the Rust compiler, pass that version to [`rust_repositories`](flatten.md#rust_repositories):
To build with a particular version of the Rust compiler, pass that version to [`rust_register_toolchains`](flatten.md#rust_register_toolchains):

```python
rust_repositories(version = "1.59.0", edition="2018")
rust_register_toolchains(version = "1.59.0", edition="2018")
```

As well as an exact version, `version` can be set to `"nightly"` or `"beta"`. If set to these values, `iso_date` must also be set:

```python
rust_repositories(version = "nightly", iso_date = "2022-02-23", edition="2018")
rust_register_toolchains(version = "nightly", iso_date = "2022-02-23", edition="2018")
```

Similarly, `rustfmt_version` may also be configured:

```python
rust_repositories(rustfmt_version = "1.59.0")
rust_register_toolchains(rustfmt_version = "1.59.0")
```

## External Dependencies
Expand Down