From a285fe29ad1ed3ae70478573df26b8a33f4bf6a7 Mon Sep 17 00:00:00 2001 From: UebelAndre Date: Sat, 26 Jun 2021 10:47:32 -0700 Subject: [PATCH] Regenerate documentation --- docs/crate_universe.md | 8 ++++++-- docs/flatten.md | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/crate_universe.md b/docs/crate_universe.md index 78baf2444a..a564058f57 100644 --- a/docs/crate_universe.md +++ b/docs/crate_universe.md @@ -9,8 +9,9 @@ ## crate_universe 
-crate_universe(name, cargo_toml_files, crate_registry_template, lockfile, overrides, packages,
-               repo_mapping, resolver_download_url_template, resolver_sha256s, supported_targets)
+crate_universe(name, cargo_toml_files, crate_registry_template, iso_date, lockfile, overrides,
+               packages, repo_mapping, resolver_download_url_template, resolver_sha256s, sha256s,
+               supported_targets, version)
A rule for downloading Rust dependencies (crates). @@ -33,13 +34,16 @@ Environment Variables: | name | A unique name for this repository. | Name | required | | | cargo_toml_files | A list of Cargo manifests (Cargo.toml files). | List of labels | optional | [] | | crate_registry_template | A template for where to download crates from for the default crate registry. This must contain {version} and {crate} templates. | String | optional | "https://crates.io/api/v1/crates/{crate}/{version}/download" | +| iso_date | The iso_date of cargo binary the resolver should use. Note version must be beta or nightly | String | optional | "" | | lockfile | The path to a file which stores pinned information about the generated dependency graph. this target must be a file and will be updated by the repository rule when the REPIN environment variable is set. If this is not set, dependencies will be re-resolved more often, setting this allows caching resolves, but will error if the cache is stale. | Label | optional | None | | overrides | Mapping of crate name to specification overrides. See [crate.override](#crateoverride) for more details. | Dictionary: String -> String | optional | {} | | packages | A list of crate specifications. See [crate.spec](#cratespec) for more details. | List of strings | optional | [] | | repo_mapping | A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.<p>For example, an entry "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target). | Dictionary: String -> String | required | | | resolver_download_url_template | URL template from which to download the resolver binary. {host_triple} and {extension} will be filled in according to the host platform. | String | optional | "{host_triple}{extension}" | | resolver_sha256s | Dictionary of host_triple -> sha256 for resolver binary. | Dictionary: String -> String | optional | {"aarch64-apple-darwin": "{aarch64-apple-darwin--sha256}", "aarch64-unknown-linux-gnu": "{aarch64-unknown-linux-gnu--sha256}", "x86_64-apple-darwin": "{x86_64-apple-darwin--sha256}", "x86_64-pc-windows-gnu": "{x86_64-pc-windows-gnu--sha256}", "x86_64-unknown-linux-gnu": "{x86_64-unknown-linux-gnu--sha256}"} | +| sha256s | The sha256 checksum of the desired rust artifacts | Dictionary: String -> String | optional | {} | | supported_targets | A list of supported [platform triples](https://doc.rust-lang.org/nightly/rustc/platform-support.html) to consider when resoliving dependencies. | List of strings | optional | ["aarch64-apple-darwin", "aarch64-unknown-linux-gnu", "x86_64-apple-darwin", "x86_64-pc-windows-msvc", "x86_64-unknown-freebsd", "x86_64-unknown-linux-gnu"] | +| version | The version of cargo the resolver should use | String | optional | "1.53.0" | diff --git a/docs/flatten.md b/docs/flatten.md index 2ac69dcbe0..8d47e3bcaa 100644 --- a/docs/flatten.md +++ b/docs/flatten.md @@ -42,8 +42,9 @@ ## crate_universe 
-crate_universe(name, cargo_toml_files, crate_registry_template, lockfile, overrides, packages,
-               repo_mapping, resolver_download_url_template, resolver_sha256s, supported_targets)
+crate_universe(name, cargo_toml_files, crate_registry_template, iso_date, lockfile, overrides,
+               packages, repo_mapping, resolver_download_url_template, resolver_sha256s, sha256s,
+               supported_targets, version)
A rule for downloading Rust dependencies (crates). @@ -66,13 +67,16 @@ Environment Variables: | name | A unique name for this repository. | Name | required | | | cargo_toml_files | A list of Cargo manifests (Cargo.toml files). | List of labels | optional | [] | | crate_registry_template | A template for where to download crates from for the default crate registry. This must contain {version} and {crate} templates. | String | optional | "https://crates.io/api/v1/crates/{crate}/{version}/download" | +| iso_date | The iso_date of cargo binary the resolver should use. Note version must be beta or nightly | String | optional | "" | | lockfile | The path to a file which stores pinned information about the generated dependency graph. this target must be a file and will be updated by the repository rule when the REPIN environment variable is set. If this is not set, dependencies will be re-resolved more often, setting this allows caching resolves, but will error if the cache is stale. | Label | optional | None | | overrides | Mapping of crate name to specification overrides. See [crate.override](#crateoverride) for more details. | Dictionary: String -> String | optional | {} | | packages | A list of crate specifications. See [crate.spec](#cratespec) for more details. | List of strings | optional | [] | | repo_mapping | A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.<p>For example, an entry "@foo": "@bar" declares that, for any time this repository depends on @foo (such as a dependency on @foo//some:target, it should actually resolve that dependency within globally-declared @bar (@bar//some:target). | Dictionary: String -> String | required | | | resolver_download_url_template | URL template from which to download the resolver binary. {host_triple} and {extension} will be filled in according to the host platform. | String | optional | "{host_triple}{extension}" | | resolver_sha256s | Dictionary of host_triple -> sha256 for resolver binary. | Dictionary: String -> String | optional | {"aarch64-apple-darwin": "{aarch64-apple-darwin--sha256}", "aarch64-unknown-linux-gnu": "{aarch64-unknown-linux-gnu--sha256}", "x86_64-apple-darwin": "{x86_64-apple-darwin--sha256}", "x86_64-pc-windows-gnu": "{x86_64-pc-windows-gnu--sha256}", "x86_64-unknown-linux-gnu": "{x86_64-unknown-linux-gnu--sha256}"} | +| sha256s | The sha256 checksum of the desired rust artifacts | Dictionary: String -> String | optional | {} | | supported_targets | A list of supported [platform triples](https://doc.rust-lang.org/nightly/rustc/platform-support.html) to consider when resoliving dependencies. | List of strings | optional | ["aarch64-apple-darwin", "aarch64-unknown-linux-gnu", "x86_64-apple-darwin", "x86_64-pc-windows-msvc", "x86_64-unknown-freebsd", "x86_64-unknown-linux-gnu"] | +| version | The version of cargo the resolver should use | String | optional | "1.53.0" |