diff options
| author |  Kristina Chodorow <kchodorow@google.com> | 2016-04-19 15:42:04 +0000 |
|---|---|---|
| committer |  Damien Martin-Guillerez <dmarting@google.com> | 2016-04-20 11:16:35 +0000 |
| commit | c10ce5c2deb818fef032802a875cd7674f6e3b99 (patch) | |
| tree | 46d2b44d6bdfbf3e54fef96ddea6621ea209ef7f /src/main/java/com/google/devtools/build | |
| parent | 2ad804cef42fbfc841dc3220de52fd406e3d69c5 (diff) | |
Document maven_jar name restrictions
Fixes #1066.
--
MOS_MIGRATED_REVID=120232176
Diffstat (limited to 'src/main/java/com/google/devtools/build')
| -rw-r--r-- | src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenJarRule.java | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenJarRule.java b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenJarRule.java index 8f2d7a4633..60aaa33a40 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenJarRule.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/rules/workspace/MavenJarRule.java @@ -83,6 +83,16 @@ public class MavenJarRule implements RuleDefinition { <p>Downloads a jar from Maven and makes it available to be used as a Java dependency.</p> +<h4 id="maven_jar_name">Naming</h4> + +<p>Note that the maven_jar name is used as a repository name, so it is limited by the rules +governing workspace names: it cannot contain dashes nor dots (see +<a href="http://bazel.io/docs/be/functions.html#workspace">the documentation on workspace names</a> +for the exact specification). By convention, maven_jar names should match the artifact name, +replacing illegal characters with underscores and leaving off the version. For example, a rule +with <code>artifact = "org.apache.commons:commons-lang3:3.4"</code> should have +<code>name = "org_apache_commons_commons_lang3"</code>.</p> + <h4 id="maven_jar_examples">Examples</h4> Suppose that the current repostory contains a java_library target that needs to depend on Guava. @@ -100,7 +110,7 @@ With Bazel, add the following lines to the WORKSPACE file: <pre> maven_jar( - name = "guava", + name = "com_google_guava_guava", artifact = "com.google.guava:guava:18.0", sha1 = "cce0823396aa693798f8882e64213b1772032b09", ) |