Documents when to use xla_test/xla_cc_test/tsl_cc_test.

PiperOrigin-RevId: 726140197
openxla · Feb 12, 2025 · a40dbd6 · a40dbd6
1 parent eabe200
commit a40dbd6
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/xla/tests/build_defs.bzl b/xla/tests/build_defs.bzl
@@ -211,6 +211,10 @@ def xla_test(
     for. This tag is of the form "xla_${BACKEND}" (eg, "xla_cpu"). These
     tags can be used to gather tests for a particular backend into a test_suite.
 
+    Use xla_test instead of cc_test or xla_cc_test in all tests that need to run
+    on specific XLA backends. Do not use xla_test in .../tsl/... directories,
+    where tsl_cc_test should be used instead.
+
     Examples:
 
       # Generates the targets: foo_test_cpu and foo_test_gpu.

diff --git a/xla/tsl/platform/default/build_config.bzl b/xla/tsl/platform/default/build_config.bzl
@@ -816,6 +816,11 @@ def tsl_cc_test(
         name,
         deps = [],
         **kwargs):
+    """A wrapper around cc_test that adds protobuf deps if needed.
+
+    Use tsl_cc_test instead of cc_test in all .../tsl/... directories.
+    """
+
     native.cc_test(
         name = name,
         deps = deps + if_tsl_link_protobuf(

diff --git a/xla/xla.bzl b/xla/xla.bzl
@@ -72,6 +72,12 @@ def xla_cc_binary(deps = [], copts = tsl_copts(), **kwargs):
     native.cc_binary(deps = deps + _XLA_SHARED_OBJECT_SENSITIVE_DEPS, copts = copts, **kwargs)
 
 def xla_cc_test(name, deps = [], **kwargs):
+    """A wrapper around cc_test that adds XLA-specific dependencies.
+
+    Use xla_cc_test or xla_test instead of cc_test in all .../xla/... directories except .../tsl/...,
+    where tsl_cc_test should be used.
+    """
+
     native.cc_test(
         name = name,
         deps = deps + _XLA_SHARED_OBJECT_SENSITIVE_DEPS,