From 3b79414815f996103f55caed92318c1799b37c5f Mon Sep 17 00:00:00 2001 From: Thomas Date: Wed, 20 Apr 2022 21:13:40 +0100 Subject: [PATCH] Fix crate annotation anchor --- crate_universe/private/crates_repository.bzl | 2 +- crate_universe/private/crates_vendor.bzl | 2 +- docs/crate_universe.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/crate_universe/private/crates_repository.bzl b/crate_universe/private/crates_repository.bzl index 92def09acc..41ace04894 100644 --- a/crate_universe/private/crates_repository.bzl +++ b/crate_universe/private/crates_repository.bzl @@ -116,7 +116,7 @@ Environment Variables: implementation = _crates_repository_impl, attrs = { "annotations": attr.string_list_dict( - doc = "Extra settings to apply to crates. See [crate.annotations](#crateannotations).", + doc = "Extra settings to apply to crates. See [crate.annotation](#crateannotation).", ), "cargo_config": attr.label( doc = "A [Cargo configuration](https://doc.rust-lang.org/cargo/reference/config.html) file", diff --git a/crate_universe/private/crates_vendor.bzl b/crate_universe/private/crates_vendor.bzl index 11cfaa1a0f..ceaba69a2e 100644 --- a/crate_universe/private/crates_vendor.bzl +++ b/crate_universe/private/crates_vendor.bzl @@ -242,7 +242,7 @@ crates_vendor = rule( doc = "A rule for defining Rust dependencies (crates) and writing targets for them to the current workspace", attrs = { "annotations": attr.string_list_dict( - doc = "Extra settings to apply to crates. See [crate.annotations](#crateannotations).", + doc = "Extra settings to apply to crates. See [crate.annotation](#crateannotation).", ), "buildifier": attr.label( doc = "The path to a [buildifier](https://github.com/bazelbuild/buildtools/blob/5.0.1/buildifier/README.md) binary used to format generated BUILD files.", diff --git a/docs/crate_universe.md b/docs/crate_universe.md index 291c1278c6..dee49d611a 100644 --- a/docs/crate_universe.md +++ b/docs/crate_universe.md @@ -194,7 +194,7 @@ Environment Variables: | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this repository. | Name | required | | -| annotations | Extra settings to apply to crates. See [crate.annotations](#crateannotations). | Dictionary: String -> List of strings | optional | {} | +| annotations | Extra settings to apply to crates. See [crate.annotation](#crateannotation). | Dictionary: String -> List of strings | optional | {} | | cargo_config | A [Cargo configuration](https://doc.rust-lang.org/cargo/reference/config.html) file | Label | optional | None | | extra_workspace_member_url_template | The registry url to use when fetching extra workspace members | String | optional | "https://crates.io/api/v1/crates/{name}/{version}/download" | | extra_workspace_members | Additional crates to download and include as a workspace member. This is unfortunately required in order to add information about "binary-only" crates so that a rust_binary may be generated for it. [rust-lang/cargo#9096](https://github.com/rust-lang/cargo/issues/9096) tracks an RFC which may solve for this. | Dictionary: String -> String | optional | {} | @@ -234,7 +234,7 @@ A rule for defining Rust dependencies (crates) and writing targets for them to t | Name | Description | Type | Mandatory | Default | | :------------- | :------------- | :------------- | :------------- | :------------- | | name | A unique name for this target. | Name | required | | -| annotations | Extra settings to apply to crates. See [crate.annotations](#crateannotations). | Dictionary: String -> List of strings | optional | {} | +| annotations | Extra settings to apply to crates. See [crate.annotation](#crateannotation). | Dictionary: String -> List of strings | optional | {} | | buildifier | The path to a [buildifier](https://github.com/bazelbuild/buildtools/blob/5.0.1/buildifier/README.md) binary used to format generated BUILD files. | Label | optional | //crate_universe/private/vendor:buildifier | | cargo_bazel | The cargo-bazel binary to use for vendoring. If this attribute is not set, then a CARGO_BAZEL_GENERATOR_PATH action env will be used. | Label | optional | @cargo_bazel_bootstrap//:binary | | generate_build_scripts | Whether or not to generate [cargo build scripts](https://doc.rust-lang.org/cargo/reference/build-scripts.html) by default. | Boolean | optional | True |