bazel
/
rules_rust
mirror of https://github.com/bazelbuild/rules_rust
2
0
Fork 0
Code Issues Releases Activity

Fix `override_targets` keys in docs (#2905) 

Updates the documentation to match the implementation:
144d34fdaa/crate_universe/src/context/crate_context.rs (L65-L74)

---------

Co-authored-by: Daniel Wagner-Hall <dawagner@gmail.com>
Co-authored-by: Daniel Wagner-Hall <dwagnerhall@apple.com>
This commit is contained in:
Max Heller 2024-10-01 16:32:09 -04:00 committed by GitHub
parent 57d6cfc174
commit 5c8f791dee
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crate_universe/private/crate.bzl
View File

@ -169,8 +169,8 @@ def _annotation(
rustc_flags (list, optional): A list of strings to set on a crate's `rust_library::rustc_flags` attribute.
shallow_since (str, optional): An optional timestamp used for crates originating from a git repository
instead of a crate registry. This flag optimizes fetching the source code.
override_targets (dict, optional): A dictionary of alternate tagets to use when something depends on this crate to allow
the parent repo to provide its own version of this dependency. Keys can be `proc_marco`, `build_script`, `lib`, `bin`.
override_targets (dict, optional): A dictionary of alternate targets to use when something depends on this crate to allow
the parent repo to provide its own version of this dependency. Keys can be `proc-marco`, `custom-build`, `lib`, `bin`.
Returns:
string: A json encoded string containing the specified version and separately all other inputs.

2
docs/src/crate_universe.md
View File

@ -519,7 +519,7 @@ A collection of extra attributes and settings for a particular crate
| <a id="crate.annotation-rustc_env_files"></a>rustc_env_files | A list of labels to set on a crate's `rust_library::rustc_env_files` attribute. | `None` |
| <a id="crate.annotation-rustc_flags"></a>rustc_flags | A list of strings to set on a crate's `rust_library::rustc_flags` attribute. | `None` |
| <a id="crate.annotation-shallow_since"></a>shallow_since | An optional timestamp used for crates originating from a git repository instead of a crate registry. This flag optimizes fetching the source code. | `None` |
| <a id="crate.annotation-override_targets"></a>override_targets | A dictionary of alternate tagets to use when something depends on this crate to allow the parent repo to provide its own version of this dependency. Keys can be `proc_marco`, `build_script`, `lib`, `bin`. | `None` |
| <a id="crate.annotation-override_targets"></a>override_targets | A dictionary of alternate targets to use when something depends on this crate to allow the parent repo to provide its own version of this dependency. Keys can be `proc-marco`, `custom-build`, `lib`, `bin`. | `None` |
**RETURNS**