xref: /aosp_15_r20/external/stardoc/test/testdata/repo_rules_test/golden.md (revision b2fa42943c124aa9c7163734493fc7a7559681cf)
1<!-- Generated with Stardoc: http://skydoc.bazel.build -->
2
3
4
5<a id="my_repo"></a>
6
7## my_repo
8
9<pre>
10my_repo(<a href="#my_repo-name">name</a>, <a href="#my_repo-repo_mapping">repo_mapping</a>, <a href="#my_repo-useless">useless</a>)
11</pre>
12
13Minimal example of a repository rule.
14
15**ATTRIBUTES**
16
17
18| Name  | Description | Type | Mandatory | Default |
19| :------------- | :------------- | :------------- | :------------- | :------------- |
20| <a id="my_repo-name"></a>name |  A unique name for this repository.   | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required |  |
21| <a id="my_repo-repo_mapping"></a>repo_mapping |  A dictionary from local repository name to global repository name. This allows controls over workspace dependency resolution for dependencies of this repository.&lt;p&gt;For example, an entry <code>"@foo": "@bar"</code> declares that, for any time this repository depends on <code>@foo</code> (such as a dependency on <code>@foo//some:target</code>, it should actually resolve that dependency within globally-declared <code>@bar</code> (<code>@bar//some:target</code>).   | <a href="https://bazel.build/rules/lib/dict">Dictionary: String -> String</a> | required |  |
22| <a id="my_repo-useless"></a>useless |  This argument will be ingored. You don't have to specify it, but you may.   | String | optional | <code>"ignoreme"</code> |
23
24
25