aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidResourcesInfoApi.java
diff options
context:
space:
mode:
authorGravatar asteinb <asteinb@google.com>2018-05-29 13:30:20 -0700
committerGravatar Copybara-Service <copybara-piper@google.com>2018-05-29 13:31:35 -0700
commit7036e9dcd5f4dfe0d74b70f5754c2d3ec78c5c3c (patch)
tree5a020f5ec3c12635e71378cc49eea55ceb9acb85 /src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidResourcesInfoApi.java
parent25f6f7b8d7b9fac825796b0153066a47fd2e20fe (diff)
Rename r_txt from AndroidResourcesInfo to compiletime_r_txt
I didn't catch it at the time this field was initially introduced, but R files from Android libraries, exposed via AndroidResourcesInfo, are compiletime only. They should not be used at runtime or inherited from dependencies. Rename the field and add this warning to the description. RELNOTES: none PiperOrigin-RevId: 198448391
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidResourcesInfoApi.java')
-rw-r--r--src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidResourcesInfoApi.java9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidResourcesInfoApi.java b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidResourcesInfoApi.java
index 67523c1471..92caa640ba 100644
--- a/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidResourcesInfoApi.java
+++ b/src/main/java/com/google/devtools/build/lib/skylarkbuildapi/android/AndroidResourcesInfoApi.java
@@ -26,10 +26,13 @@ import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory;
category = SkylarkModuleCategory.PROVIDER)
public interface AndroidResourcesInfoApi extends StructApi {
- /** Returns the r.txt file for the target. */
+ /** Returns the compiletime r.txt file for the target. */
@SkylarkCallable(
- name = "r_txt",
- doc = "Returns the R.txt file for the target.",
+ name = "compiletime_r_txt",
+ doc =
+ "A txt file containing compiled resource file information for this target. This is a"
+ + " stubbed out compiletime file and should not be built into APKs, inherited from"
+ + " dependencies, or used at runtime.",
structField = true)
FileApi getRTxt();
}