From 211dc6130e5bacf1a34aec6377f251800763fed4 Mon Sep 17 00:00:00 2001 From: Fabian Meumertzheim Date: Fri, 28 Oct 2022 15:11:43 +0200 Subject: [PATCH] Use "apparent name" instead of "local name" in Bzlmod docs (#16604) "Apparent" is used all over the codebase now, so it makes sense to also use it in user-facing docs. Also slightly rewords the definition of an "apparent repository name" to make it easier to understand. Closes #16548. PiperOrigin-RevId: 484507525 Change-Id: I8e3af88ddbe5f7b31af47d3ea5a6821ac6e71056 --- site/en/build/bzlmod.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/site/en/build/bzlmod.md b/site/en/build/bzlmod.md index fdb0864c8d4125..bcf89dd3e36a38 100644 --- a/site/en/build/bzlmod.md +++ b/site/en/build/bzlmod.md @@ -164,9 +164,9 @@ mechanism in the new system. Here are two important concepts: * For module extension repos: `{{ "" }}module_name{{ "" }}~{{ "" }}version{{ "" }}~{{ "" }}extension_name{{ "" }}~{{ "" }}repo_name{{ "" }}`
(Example. `@rules_cc~0.0.1~cc_configure~local_config_cc`) -* **Local repository name**: The repository name to be used in the `BUILD` and - `.bzl` files within a repo. The same dependency could have different local - names for different repos. +* **Apparent repository name**: The repository name to be used in the `BUILD` and + `.bzl` files within a repo. The same dependency could have different apparent + names in different repos.
It's determined as follows: * For Bazel module repos: `{{ "" }}module_name{{ "" }}` by @@ -176,10 +176,10 @@ mechanism in the new system. Here are two important concepts: [`use_repo`](/rules/lib/globals#use_repo). Every repository has a repository mapping dictionary of its direct dependencies, -which is a map from the local repository name to the canonical repository name. +which is a map from the apparent repository name to the canonical repository name. We use the repository mapping to resolve the repository name when constructing a label. Note that, there is no conflict of canonical repository names, and the -usages of local repository names can be discovered by parsing the `MODULE.bazel` +usages of apparent repository names can be discovered by parsing the `MODULE.bazel` file, therefore conflicts can be easily caught and resolved without affecting other dependencies.