Merge pull request #71167 from vanvoorden/vanvoorden/inclusive-language

[Inclusive Language][Comments][Documentation] migrate "sanity" checks to "soundness" checks

Author: glessard

cmake/modules/SwiftXcodeSupport.cmake

@@ -84,7 +84,7 @@ function(fix_imported_targets_for_xcode imported_targets)
     endif()
 
     # First check that we actually imported the configuration that LLVM said
-    # that we did. This is just a sanity check.
+    # that we did. This is just a soundness check.
     check_imported_target_has_imported_configuration(${target} ${LLVM_BUILD_TYPE_UPPER})
 
     # Then loop through all of the imported properties and translate.

docs/ContinuousIntegration.md

@@ -87,7 +87,7 @@ All supported platforms     | @swift-ci Please clean test                   | Sw
 macOS platform               | @swift-ci Please test macOS platform           | Swift Test macOS Platform (smoke test)<br>Swift Test macOS Platform
 macOS platform               | @swift-ci Please clean test macOS platform     | Swift Test macOS Platform (smoke test)<br>Swift Test macOS Platform
 macOS platform               | @swift-ci Please benchmark                    | Swift Benchmark on macOS Platform (many runs - rigorous)
-macOS platform               | @swift-ci Please smoke benchmark              | Swift Benchmark macOS Platform (few runs - sanity)
+macOS platform               | @swift-ci Please smoke benchmark              | Swift Benchmark macOS Platform (few runs - soundness)
 Linux platform               | @swift-ci Please test Linux platform          | Swift Test Linux Platform (smoke test)<br>Swift Test Linux Platform
 Linux platform               | @swift-ci Please clean test Linux platform    | Swift Test Linux Platform (smoke test)<br>Swift Test Linux Platform
 macOS platform               | @swift-ci Please ASAN test                    | Swift ASAN Test macOS Platform
@@ -126,7 +126,7 @@ A validation test on Linux does the following:
 Platform        | Comment | Check Status
 ------------    | ------- | ------------
 macOS platform  | @swift-ci Please benchmark       | Swift Benchmark on macOS Platform (many runs - rigorous)
-macOS platform  | @swift-ci Please smoke benchmark | Swift Benchmark on macOS Platform (few runs - sanity)
+macOS platform  | @swift-ci Please smoke benchmark | Swift Benchmark on macOS Platform (few runs - soundness)
 
 ### Linting
 

docs/StringDesign.rst

@@ -540,7 +540,7 @@ programmers well; so, why does Swift have its own string type?
 * C strings had to stay around for performance reasons and
   interoperability
 
-Want performance of C, sane semantics of C++ strings, and high-level
+Want performance of C, sound semantics of C++ strings, and high-level
 goodness of ObjC.
 
    The design of ``NSString`` is *very* different from the string

docs/archive/LangRef.html

@@ -490,7 +490,7 @@ <h3 id="decl-struct">struct Declarations</h3>
     Structs do not support inheritance due to undesirable ripple effects across
     the design of the language. For example, method dispatch would arguably need
     to become virtual, not static. The storage of the type would arguably need
-    to become indirected so that an array of T could be implemented sanely
+    to become indirected so that an array of T could be implemented soundly
     (because we don't know if T is actually a T, or a subclass of T). We'd need
     to store the "isa"/vtable in the struct so that virtual method dispatch
     could be implemented, and this has additional storage costs. None of these

docs/proposals/rejected/ClassConstruction.rst

@@ -9,7 +9,7 @@
 
 Objective-C's "designated initializers pattern seems at first to
 create a great deal of complication.  However, designated initializers
-are simply the only sane response to Objective-C's initialization rules,
+are simply the only sound response to Objective-C's initialization rules,
 which are the root cause of the complication.
 
 This proposal suggests an approach to initialization that avoids the

include/swift/Basic/UUID.h

@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 //
 // This is an interface over the standard OSF uuid library that gives UUIDs
-// sane value semantics and operators.
+// sound value semantics and operators.
 //
 //===----------------------------------------------------------------------===//
 

include/swift/RemoteInspection/ReflectionContext.h

@@ -1177,7 +1177,7 @@ class ReflectionContext
   bool projectEnumValue(RemoteAddress EnumAddress, const TypeRef *EnumTR,
                         int *CaseIndex,
                         remote::TypeInfoProvider *ExternalTypeInfo) {
-    // Get the TypeInfo and sanity-check it
+    // Get the TypeInfo and soundness-check it
     if (EnumTR == nullptr) {
       return false;
     }

include/swift/RemoteInspection/TypeRefBuilder.h

@@ -994,7 +994,7 @@ class TypeRefBuilder {
       return nullptr;
     }
 
-    // Sanity:  Verify that the generic params per level add
+    // Soundness:  Verify that the generic params per level add
     // up exactly to the number of args we were provided, and
     // that we don't have a rediculous number of either one
     auto genericParamsPerLevel = *maybeGenericParamsPerLevel;

include/swift/SIL/FieldSensitivePrunedLiveness.h

@@ -1046,7 +1046,7 @@ class FieldSensitivePrunedLivenessBoundary {
 public:
   FieldSensitivePrunedLivenessBoundary(unsigned numBits) : numBits(numBits) {}
 
-  /// Sanity check meant for NDEBUG mode.
+  /// Soundness check meant for NDEBUG mode.
   unsigned getNumLastUsersAndDeadDefs(unsigned bitNo) const {
 #ifdef NDEBUG
     llvm_unreachable("Only call in asserts build!\n");

lib/AST/ASTContext.cpp

@@ -2257,7 +2257,7 @@ void OverriddenDeclsRequest::cacheResult(
   if (value.empty())
     return;
 
-  // Sanity-check the declarations we were given.
+  // Soundness-check the declarations we were given.
   for (auto overriddenDecl : value) {
     assert(overriddenDecl->getKind() == decl->getKind() &&
            "Overridden decl kind mismatch");