Skip to content

Commit ed7e09a

Browse files
committed
Warning-only => advisory
1 parent bb5f67e commit ed7e09a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

proposals/testing/NNNN-targeted-interoperability-swift-testing-and-xctest.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Here are some concrete examples:
159159

160160
### Interoperability Modes
161161

162-
- **Warning-only**: Test failures that were previously ignored are reported as
162+
- **Advisory**: Test failures that were previously ignored are reported as
163163
runtime warning issues. It also includes runtime warning issues for XCTest API
164164
usage in a Swift Testing context. This is for projects which do not want to
165165
see new test failures surfaced due to interoperability.
@@ -178,7 +178,7 @@ Configure the interoperability mode when running tests using the
178178

179179
| Interop Mode | Issue behaviour across framework boundary | `SWIFT_TESTING_XCTEST_INTEROP_MODE` |
180180
| ------------ | -------------------------------------------------------------------------- | ---------------------------------------------- |
181-
| Warning-only | XCTest API: ⚠️ Runtime Warning Issue. All Issues: ⚠️ Runtime Warning Issue | `warning-only` |
181+
| Advisory | XCTest API: ⚠️ Runtime Warning Issue. All Issues: ⚠️ Runtime Warning Issue | `warning-only` |
182182
| Permissive | XCTest API: ⚠️ Runtime Warning Issue. All Issues: ❌ Test Failure | `permissive`, or empty value, or invalid value |
183183
| Strict | XCTest API: 💥 `fatalError`. Swift Testing API: ❌ Test Failure | `strict` |
184184

@@ -195,7 +195,7 @@ lead to situations where previously "passing" test code now starts showing
195195
failures. We believe this should be a net positive if it can highlight actual
196196
bugs you would have missed previously.
197197

198-
You can use `SWIFT_TESTING_XCTEST_INTEROP_MODE=warning-only` in the short-term
198+
You can use `SWIFT_TESTING_XCTEST_INTEROP_MODE=advisory` in the short-term
199199
to revert any changes to test pass/fail outcomes as a result of
200200
interoperability.
201201

@@ -249,7 +249,7 @@ should make it clear that this is not intended to be a permanent measure.
249249
In a similar vein, we considered `SWIFT_TESTING_XCTEST_INTEROP_MODE=off` as a
250250
way to completely turn off interoperability. Some projects may additionally have
251251
an issue handling trait that promotes warnings to errors, which means that
252-
warning-only mode could still cause test failures.
252+
advisory mode could still cause test failures.
253253

254254
However, in the scenario above, we think users who set up tests to elevate
255255
warnings as errors would be interested in increased visibility of testing issues
@@ -282,7 +282,7 @@ disruptive to the testing flow.
282282
- **CLI option through SwiftPM:**
283283

284284
```
285-
swift test --interop-mode=warning-only
285+
swift test --interop-mode=advisory
286286
```
287287

288288
This could be offered in addition to the proposed environment variable option,

0 commit comments

Comments
 (0)