Merge pull request #37119 from lorentey/abi-tests-clarifications

[stdlib][test] Update stdlib abi test docs

Author: lorentey

test/api-digester/stability-stdlib-abi-with-asserts.test

@@ -7,25 +7,41 @@
 // RUN: %clang -E -P -x c %t.tmp/changes.txt -o - | sed '/^\s*$/d' | sort > %t.tmp/changes.txt.tmp
 // RUN: diff -u %t.tmp/stability-stdlib-abi.swift.expected.sorted %t.tmp/changes.txt.tmp
 
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment below.)
+
 // Welcome, Build Wrangler!
 //
-// A failure in this test indicates that there is a potential ABI breaking
-// change in the Standard Library. If you observe a failure, please reach out to
-// the Standard Library team directly to make sure we resolve this quickly!
+// This file lists APIs that are unique to stdlib builds with assertions.
+// (It is combined with the stability-stdlib-abi-without-asserts.test file
+// to generate a full list of potentially breaking API changes. In most cases
+// you'll want to edit that file instead of this one.)
+//
+// A failure in this test indicates that there is a potential breaking change in
+// the Standard Library. If you observe a failure outside of a PR test, please
+// reach out to the Standard Library team directly to make sure this gets
+// resolved quickly! If your own PR fails in this test, you probably have an
+// ABI- or source-breaking change in your commits. Please go and fix it.
 //
-// Please DO NOT XFAIL THIS TEST. In addition to ignoring the current set of ABI
-// breaks, XFAILing this test also silences any future ABI breaks that may land
-// on this branch, which isn't ideal.
+// Please DO NOT DISABLE THIS TEST. In addition to ignoring the current set of
+// ABI breaks, XFAILing this test also silences any future ABI breaks that may
+// land on this branch, which simply generates extra work for the next person
+// that picks up the mess.
 //
-// Instead, consider extending the list of expected changes at the bottom. You
-// can find a diff of what needs to be added in the output of the failed test
-// run. The order of lines doesn't matter, and you can also include comments to
-// refer to any bugs you filed.
+// Instead of disabling this test, consider extending the list of expected
+// changes at the bottom. (You'll also need to do this if your own PR triggers
+// false positives, or if you have special permission to break things.) You can
+// find a diff of what needs to be added in the output of the failed test run.
+// The order of lines doesn't matter, and you can also include comments to refer
+// to any bugs you filed. Remember that in almost all cases you'll want to edit
+// the stability-stdlib-abi-without-asserts.test file instead of this one.
 //
-// Thanks! -- Your friendly stdlib engineers
+// Thank you for your help ensuring the stdlib remains compatible with its past!
+//                                            -- Your friendly stdlib engineers
 
 // REQUIRES: swift_stdlib_asserts
 
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment above.)
+
 // SR-13362
 // We currently only have a baseline for Intel CPUs on macOS.
 // REQUIRES: OS=macosx
@@ -35,7 +51,7 @@
 // declarations are shuffled. rdar://problem/46618883
 // UNSUPPORTED: swift_evolve
 
-// *** DO NOT XFAIL THIS TEST *** (See comment above.)
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment above.)
 
 Func _collectReferencesInsideObject(_:) is a new API without @available attribute
 Func _loadDestroyTLSCounter() is a new API without @available attribute
@@ -44,3 +60,5 @@ Protocol _RuntimeFunctionCountersStats is a new API without @available attribute
 Struct _GlobalRuntimeFunctionCountersState is a new API without @available attribute
 Struct _ObjectRuntimeFunctionCountersState is a new API without @available attribute
 Struct _RuntimeFunctionCounters is a new API without @available attribute
+
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment above.)

test/api-digester/stability-stdlib-abi-without-asserts.test

@@ -5,25 +5,38 @@
 // RUN: %clang -E -P -x c %t.tmp/changes.txt -o - | sed '/^\s*$/d' | sort > %t.tmp/changes.txt.tmp
 // RUN: diff -u %t.tmp/stability-stdlib-abi.swift.expected %t.tmp/changes.txt.tmp
 
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment below.)
+
 // Welcome, Build Wrangler!
 //
-// A failure in this test indicates that there is a potential ABI breaking
-// change in the Standard Library. If you observe a failure, please reach out to
-// the Standard Library team directly to make sure we resolve this quickly!
+// This file lists APIs that have recently changed in a way that potentially
+// indicates an ABI- or source-breaking problem.
+//
+// A failure in this test indicates that there is a potential breaking change in
+// the Standard Library. If you observe a failure outside of a PR test, please
+// reach out to the Standard Library team directly to make sure this gets
+// resolved quickly! If your own PR fails in this test, you probably have an
+// ABI- or source-breaking change in your commits. Please go and fix it.
 //
-// Please DO NOT XFAIL THIS TEST. (In addition to ignoring the current set of
+// Please DO NOT DISABLE THIS TEST. In addition to ignoring the current set of
 // ABI breaks, XFAILing this test also silences any future ABI breaks that may
-// land on this branch, which isn't ideal.)
+// land on this branch, which simply generates extra work for the next person
+// that picks up the mess.
 //
-// Instead, consider extending the list of expected changes at the bottom. You
-// can find a diff of what needs to be added in the output of the failed test
-// run. The order of lines doesn't matter, and you can also include comments to
-// refer to any bugs you filed.
+// Instead of disabling this test, you'll need to extend the list of expected
+// changes at the bottom. (You'll also need to do this if your own PR triggers
+// false positives, or if you have special permission to break things.) You can
+// find a diff of what needs to be added in the output of the failed test run.
+// The order of lines doesn't matter, and you can also include comments to refer
+// to any bugs you filed.
 //
-// Thanks! -- Your friendly stdlib engineers
+// Thank you for your help ensuring the stdlib remains compatible with its past!
+//                                            -- Your friendly stdlib engineers
 
 // REQUIRES: swift_stdlib_no_asserts
 
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment above.)
+
 // SR-13362
 // We currently only have a baseline for Intel CPUs on macOS.
 // REQUIRES: OS=macosx && CPU=x86_64
@@ -32,7 +45,7 @@
 // declarations are shuffled. rdar://problem/46618883
 // UNSUPPORTED: swift_evolve
 
-// *** DO NOT XFAIL THIS TEST. *** See comment above.
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment above.)
 
 Func _prespecialize() is a new API without @available attribute
 Func _stdlib_isOSVersionAtLeastOrVariantVersionAtLeast(_:_:_:_:_:_:) is a new API without @available attribute
@@ -57,3 +70,5 @@ Protocol CodingKey has added inherited protocol Sendable
 Protocol CodingKey has generic signature change from <Self : Swift.CustomDebugStringConvertible, Self : Swift.CustomStringConvertible> to <Self : Swift.CustomDebugStringConvertible, Self : Swift.CustomStringConvertible, Self : Swift.Sendable>
 Protocol Error has added inherited protocol Sendable
 Protocol Error has generic signature change from to <Self : Swift.Sendable>
+
+// *** DO NOT DISABLE OR XFAIL THIS TEST. *** (See comment above.)