aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/rules
diff options
context:
space:
mode:
authorGravatar dslomov <dslomov@google.com>2017-08-31 12:12:45 +0200
committerGravatar Vladimir Moskva <vladmos@google.com>2017-08-31 13:45:54 +0200
commitd617c2de2eb7f2a2cc6a95e42b0f53c057c90e9b (patch)
tree339e333e74cf05df090fcc0c00ab3fbd2878df85 /src/main/java/com/google/devtools/build/lib/rules
parent9e3b8da34602e0e4286fa45380fec884c1464500 (diff)
Add JavaInfo as a (preferred) alias to java_common.provider.
RELNOTES: `JavaInfo` is a preferred alias to `java_common.provider`. PiperOrigin-RevId: 167116971
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/rules')
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/java/JavaInfo.java4
-rw-r--r--src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkCommon.java8
2 files changed, 7 insertions, 5 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/rules/java/JavaInfo.java b/src/main/java/com/google/devtools/build/lib/rules/java/JavaInfo.java
index f50fae3012..787d460f82 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/java/JavaInfo.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/java/JavaInfo.java
@@ -36,7 +36,7 @@ import javax.annotation.Nullable;
/** A Skylark declared provider that encapsulates all providers that are needed by Java rules. */
@SkylarkModule(
- name = "java_common.provider",
+ name = "JavaInfo",
doc = "Encapsulates all information provided by Java rules",
category = SkylarkModuleCategory.PROVIDER
)
@@ -44,7 +44,7 @@ import javax.annotation.Nullable;
public final class JavaInfo extends NativeInfo {
public static final NativeProvider<JavaInfo> PROVIDER =
- new NativeProvider<JavaInfo>(JavaInfo.class, "java_common.provider") {};
+ new NativeProvider<JavaInfo>(JavaInfo.class, "JavaInfo") {};
private static final ImmutableSet<Class<? extends TransitiveInfoProvider>> ALLOWED_PROVIDERS =
ImmutableSet.of(
diff --git a/src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkCommon.java b/src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkCommon.java
index 2567876b66..2d9288e3d2 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkCommon.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/java/JavaSkylarkCommon.java
@@ -49,7 +49,9 @@ public class JavaSkylarkCommon {
@SkylarkCallable(
name = "provider",
structField = true,
- doc = "Returns the Java declared provider."
+ doc = "Returns the Java declared provider. <br>"
+ + "The same value is accessible as <code>JavaInfo</code>. <br>"
+ + "Prefer using <code>JavaInfo</code> in new code."
)
public Provider getJavaProvider() {
return JavaInfo.PROVIDER;
@@ -58,7 +60,7 @@ public class JavaSkylarkCommon {
@SkylarkCallable(
name = "create_provider",
documented = false,
- doc = "Create a java_common.provider from pre-built jars. Note that compile_time_jars and "
+ doc = "Create JavaInfo from pre-built jars. Note that compile_time_jars and "
+ "runtime_jars are not automatically merged into the recursive jars - if this is the "
+ "desired behaviour the user should merge the jars before creating the provider. "
+ "The recursive (compile/runtime) jars are the jars usually collected transitively from "
@@ -414,7 +416,7 @@ public class JavaSkylarkCommon {
@SkylarkCallable(
name = "merge",
- doc = "Merges the given providers into a single java_common.provider.",
+ doc = "Merges the given providers into a single JavaInfo.",
// We have one positional argument: the list of providers to merge.
mandatoryPositionals = 1
)