Skip to content

Commit

Permalink
Use "apparent name" instead of "local name" in Bzlmod docs (#16604)
Browse files Browse the repository at this point in the history
"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
  • Loading branch information
fmeum authored Oct 28, 2022
1 parent e401b16 commit 211dc61
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions site/en/build/bzlmod.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,9 +164,9 @@ mechanism in the new system. Here are two important concepts:
* For module extension repos: `{{ "<var>" }}module_name{{ "</var>" }}~{{ "<var>" }}version{{ "</var>" }}~{{ "<var>" }}extension_name{{ "</var>" }}~{{ "<var>" }}repo_name{{ "</var>" }}`
<br>(<b>Example</b>. `@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.
<br>It's determined as follows:

* For Bazel module repos: `{{ "<var>" }}module_name{{ "</var>" }}` by
Expand All @@ -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.

Expand Down

0 comments on commit 211dc61

Please sign in to comment.