From 2ac0dfa987285a58b70da2d1b6214110f5c124e6 Mon Sep 17 00:00:00 2001 From: Daniel Wagner-Hall Date: Wed, 13 Oct 2021 15:22:28 +0100 Subject: [PATCH] Regenerate documentation --- docs/flatten.md | 6 ++++-- docs/rust_repositories.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/flatten.md b/docs/flatten.md index 4f594c6a0b..1f32578ed4 100644 --- a/docs/flatten.md +++ b/docs/flatten.md @@ -1192,7 +1192,7 @@ See @rules_rust//rust:repositories.bzl for examples of defining the @rust_cpuX r ## rust_toolchain_repository 
-rust_toolchain_repository(name, dev_components, edition, exec_triple, extra_target_triples,
+rust_toolchain_repository(name, auth, dev_components, edition, exec_triple, extra_target_triples,
                           include_rustc_srcs, iso_date, repo_mapping, rustfmt_version, sha256s,
                           toolchain_name_prefix, urls, version)
@@ -1207,6 +1207,7 @@ A given instance of this rule should be accompanied by a rust_toolchain_reposito | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this repository. | Name | required | | +| auth | Auth object compatible with repository_ctx.download to use when downloading files. See https://docs.bazel.build/versions/main/skylark/lib/repository_ctx.html#download for more details. | Dictionary: String -> String | optional | {} | | dev_components | Whether to download the rustc-dev components (defaults to False). Requires version to be "nightly". | Boolean | optional | False | | edition | The rust edition to be used by default. | String | optional | "2018" | | exec_triple | The Rust-style target that this compiler runs on | String | required | | @@ -1797,7 +1798,7 @@ See `load_arbitrary_tool` in `@rules_rust//rust:repositories.bzl` for more detai 
 rust_repository_set(name, version, exec_triple, include_rustc_srcs, extra_target_triples, iso_date,
-                    rustfmt_version, edition, dev_components, sha256s, urls)
+                    rustfmt_version, edition, dev_components, sha256s, urls, auth)
Assembles a remote repository for the given toolchain params, produces a proxy repository to contain the toolchain declaration, and registers the toolchains. @@ -1821,6 +1822,7 @@ N.B. A "proxy repository" is needed to allow for registering the toolchain (with | dev_components | Whether to download the rustc-dev components. Requires version to be "nightly". Defaults to False. | False | | sha256s | A dict associating tool subdirectories to sha256 hashes. See [rust_repositories](#rust_repositories) for more details. | None | | urls | A list of mirror urls containing the tools from the Rust-lang static file server. These must contain the '{}' used to substitute the tool being fetched (using .format). Defaults to ['https://static.rust-lang.org/dist/{}.tar.gz'] | ["https://static.rust-lang.org/dist/{}.tar.gz"] | +| auth | Auth object compatible with repository_ctx.download to use when downloading files. See https://docs.bazel.build/versions/main/skylark/lib/repository_ctx.html#download for more details. | None | diff --git a/docs/rust_repositories.md b/docs/rust_repositories.md index b3471c4b03..a0dc3b1a1b 100644 --- a/docs/rust_repositories.md +++ b/docs/rust_repositories.md @@ -112,7 +112,7 @@ See @rules_rust//rust:repositories.bzl for examples of defining the @rust_cpuX r ## rust_toolchain_repository 
-rust_toolchain_repository(name, dev_components, edition, exec_triple, extra_target_triples,
+rust_toolchain_repository(name, auth, dev_components, edition, exec_triple, extra_target_triples,
                           include_rustc_srcs, iso_date, repo_mapping, rustfmt_version, sha256s,
                           toolchain_name_prefix, urls, version)
@@ -127,6 +127,7 @@ A given instance of this rule should be accompanied by a rust_toolchain_reposito | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this repository. | Name | required | | +| auth | Auth object compatible with repository_ctx.download to use when downloading files. See https://docs.bazel.build/versions/main/skylark/lib/repository_ctx.html#download for more details. | Dictionary: String -> String | optional | {} | | dev_components | Whether to download the rustc-dev components (defaults to False). Requires version to be "nightly". | Boolean | optional | False | | edition | The rust edition to be used by default. | String | optional | "2018" | | exec_triple | The Rust-style target that this compiler runs on | String | required | | @@ -212,7 +213,7 @@ See `load_arbitrary_tool` in `@rules_rust//rust:repositories.bzl` for more detai 
 rust_repository_set(name, version, exec_triple, include_rustc_srcs, extra_target_triples, iso_date,
-                    rustfmt_version, edition, dev_components, sha256s, urls)
+                    rustfmt_version, edition, dev_components, sha256s, urls, auth)
Assembles a remote repository for the given toolchain params, produces a proxy repository to contain the toolchain declaration, and registers the toolchains. @@ -236,5 +237,6 @@ N.B. A "proxy repository" is needed to allow for registering the toolchain (with | dev_components | Whether to download the rustc-dev components. Requires version to be "nightly". Defaults to False. | False | | sha256s | A dict associating tool subdirectories to sha256 hashes. See [rust_repositories](#rust_repositories) for more details. | None | | urls | A list of mirror urls containing the tools from the Rust-lang static file server. These must contain the '{}' used to substitute the tool being fetched (using .format). Defaults to ['https://static.rust-lang.org/dist/{}.tar.gz'] | ["https://static.rust-lang.org/dist/{}.tar.gz"] | +| auth | Auth object compatible with repository_ctx.download to use when downloading files. See https://docs.bazel.build/versions/main/skylark/lib/repository_ctx.html#download for more details. | None |