Skip to content

Commit 9eec249

Browse files
authored
[docs] Document the swift-lldb test whitelist (swiftlang#18730)
1 parent dc00fa4 commit 9eec249

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/Testing.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -501,3 +501,18 @@ code that uses an ``if true {}`` or similar no-op scope instead of
501501
If you're specifically testing the autoreleasing behavior of code, or do not
502502
expect code to interact with the Objective-C runtime, it may be OK to use ``if
503503
true {}``, but those assumptions should be commented in the test.
504+
505+
#### Enabling/disabling the lldb test whitelist
506+
507+
It's possible to enable a whitelist of swift-specific lldb tests to run during
508+
PR smoke testing. Note that the default set of tests which run (which includes
509+
tests not in the whitelist) already only includes swift-specific tests.
510+
511+
Enabling the whitelist is an option of last-resort to unblock swift PR testing
512+
in the event that lldb test failures cannot be resolved in a timely way. If
513+
this becomes necessary, be sure to double-check that enabling the whitelist
514+
actually unblocks PR testing by running the smoke test build preset locally.
515+
516+
To enable the lldb test whitelist, add `-G swiftpr` to the
517+
`LLDB_TEST_CATEGORIES` variable in `utils/build-script-impl`. Disable it by
518+
removing that option.

0 commit comments

Comments
 (0)