diff options
| author |  Kristina Chodorow <kchodorow@google.com> | 2015-03-03 18:04:56 +0000 |
|---|---|---|
| committer |  Han-Wen Nienhuys <hanwen@google.com> | 2015-03-05 18:07:29 +0000 |
| commit | 7a6c624116a78259ac07ff984150019b95b9db2f (patch) | |
| tree | 351039cf882ab472dea9e4f5d6236d26509c2699 /src/main/java/com/google/devtools/build | |
| parent | e677a910d41ca8a5b72fe211d2cc544e51ac0169 (diff) | |
Add documentation for workspace()
--
MOS_MIGRATED_REVID=87622845
Diffstat (limited to 'src/main/java/com/google/devtools/build')
| -rw-r--r-- | src/main/java/com/google/devtools/build/docgen/templates/be-footer.html | 25 | ||||
| -rw-r--r-- | src/main/java/com/google/devtools/build/docgen/templates/be-header.html | 1 |
2 files changed, 26 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be-footer.html b/src/main/java/com/google/devtools/build/docgen/templates/be-footer.html index 7fd649d9cf..75c764e77f 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be-footer.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/be-footer.html @@ -563,6 +563,31 @@ sh_binary( </li> </ul> +<!-- ================================================================= + workspace() + ================================================================= +--> + +<h3 id="workspace">workspace</h3> + +<p><code>workspace(name = "something")</code></p> + +<p>This can only be used in the WORKSPACE file.</p> + +<p>The sets an optional name for the repository.</p> + +<p>This name is used for the directory that runfiles are stored in. For + example, if there is a runfile foo/bar and the WORKSPACE file contains + <code>workspace(name = "baz")</code>, then the runfile will be output under + mytarget.runfiles/baz/foo/bar. If no workspace name is specified, then the + runfile will be symlinked to bar.runfiles/foo/bar. +</p> + +<p>A workspace name can contain slashes if a deeper directory listing is + desired (<code>workspace(name = "baz/qux")</code> will place the runfile at + bar.runfiles/baz/qux/foo/bar). +</p> + </div> </div> </body> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be-header.html b/src/main/java/com/google/devtools/build/docgen/templates/be-header.html index 3e8fdff0a2..0aba2e7892 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be-header.html +++ b/src/main/java/com/google/devtools/build/docgen/templates/be-header.html @@ -210,6 +210,7 @@ ${LEFT_PANEL} <li><a href="#exports_files">exports_files</a></li> <li><a href="#glob">glob</a></li> <li><a href="#select">select</a></li> + <li><a href="#workspace">workspace</a></li> </ul> </td></tr></table> |