update CREATE_XCRESULT_BUNDLE comment (#1952)

Users should set `create_xcresult_bundle` on the runner instead --------- Co-authored-by: Matt Robinson <[email protected]>
bazelbuild · Apr 27, 2023 · 796fae6 · 796fae6
1 parent 213e3ee
commit 796fae6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/apple/testing/default_runner/ios_xctestrun_runner.bzl b/apple/testing/default_runner/ios_xctestrun_runner.bzl
@@ -182,7 +182,8 @@ ios_unit_test(
 ```
 
 If you would like this test runner to generate xcresult bundles for your tests,
-pass `--test_env=CREATE_XCRESULT_BUNDLE=1`
+pass `--test_env=CREATE_XCRESULT_BUNDLE=1`. It is preferable to use the
+`create_xcresult_bundle` on the test runner itself instead of this parameter.
 
 This rule automatically handles running x86_64 tests on arm64 hosts. The only
 exception is that if you want to generate xcresult bundles or run tests in

diff --git a/doc/rules-ios.md b/doc/rules-ios.md
@@ -660,7 +660,8 @@ ios_unit_test(
 ```
 
 If you would like this test runner to generate xcresult bundles for your tests,
-pass `--test_env=CREATE_XCRESULT_BUNDLE=1`
+pass `--test_env=CREATE_XCRESULT_BUNDLE=1`. It is preferable to use the
+`create_xcresult_bundle` on the test runner itself instead of this parameter.
 
 This rule automatically handles running x86_64 tests on arm64 hosts. The only
 exception is that if you want to generate xcresult bundles or run tests in