[inclusive-language] changed sanity to soundness

Author: vanvoorden

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

@@ -2204,7 +2204,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");

lib/AST/Builtins.cpp

@@ -115,7 +115,7 @@ Type swift::getBuiltinType(ASTContext &Context, StringRef Name) {
   if (Name.substr(0, 3) == "Int") {
     unsigned BitWidth;
     if (!Name.substr(3).getAsInteger(10, BitWidth) &&
-        BitWidth <= 2048 && BitWidth != 0)  // Cap to prevent insane things.
+        BitWidth <= 2048 && BitWidth != 0)  // Cap to prevent unsound things.
       return BuiltinIntegerType::get(BitWidth, Context);
   }
 

lib/Basic/UUID.cpp

@@ -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.
 //
 //===----------------------------------------------------------------------===//
 

lib/ClangImporter/ImportDecl.cpp

@@ -9338,7 +9338,7 @@ static void loadMembersOfBaseImportedFromClang(ExtensionDecl *ext) {
     return;
   base->loadAllMembers();
 
-  // Sanity check: make sure we don't jump over to a category /while/
+  // Soundness check: make sure we don't jump over to a category /while/
   // loading the original class's members. Right now we only check if this
   // happens on the first member.
   if (auto *clangContainer = dyn_cast<clang::ObjCContainerDecl>(clangBase))

lib/ClangImporter/ImportType.cpp

@@ -1704,7 +1704,7 @@ ImportedType ClangImporter::Implementation::importType(
   // separately, so it can provide fallbacks in certain cases. For Swift, we
   // map the redefinition types back to the equivalent of the built-in types.
   // This bans some trickery that the redefinition types enable, but is a more
-  // sane model overall.
+  // sound model overall.
   auto &clangContext = getClangASTContext();
   if (clangContext.getLangOpts().ObjC) {
     if (clangContext.hasSameUnqualifiedType(

lib/IRGen/IRGenDebugInfo.cpp

@@ -467,7 +467,7 @@ class IRGenDebugInfoImpl : public IRGenDebugInfo {
 private:
 
 #ifndef NDEBUG
-  /// Perform a couple of sanity checks on scopes.
+  /// Perform a couple of soundness checks on scopes.
   static bool parentScopesAreSane(const SILDebugScope *DS) {
     auto *Parent = DS;
     while ((Parent = Parent->Parent.dyn_cast<const SILDebugScope *>())) {
@@ -742,7 +742,7 @@ class IRGenDebugInfoImpl : public IRGenDebugInfo {
     return DBuilder.getOrCreateTypeArray(Parameters);
   }
 
-  /// FIXME: replace this condition with something more sane.
+  /// FIXME: replace this condition with something more sound.
   static bool isAllocatingConstructor(SILFunctionTypeRepresentation Rep,
                                       DeclContext *DeclCtx) {
     return Rep != SILFunctionTypeRepresentation::Method && DeclCtx &&
@@ -2135,7 +2135,7 @@ class IRGenDebugInfoImpl : public IRGenDebugInfo {
     // Incrementally build the DIRefMap.
     if (auto *CTy = dyn_cast<llvm::DICompositeType>(DITy)) {
 #ifndef NDEBUG
-      // Sanity check.
+      // Soundness check.
       if (llvm::Metadata *V = DIRefMap.lookup(UID)) {
         auto *CachedTy = cast<llvm::DIType>(V);
         assert(CachedTy == DITy && "conflicting types for one UID");
@@ -2969,7 +2969,7 @@ void IRGenDebugInfoImpl::emitVariableDeclaration(
       if (!AlignInBits)
         AlignInBits = SizeOfByte;
 
-      // Sanity checks.
+      // Soundness checks.
 #ifndef NDEBUG
       assert(SizeInBits && "zero-sized piece");
       if (getSizeInBits(Var)) {

lib/IRGen/IRGenModule.cpp

@@ -190,7 +190,7 @@ static void checkPointerAuthAssociatedTypeDiscriminator(IRGenModule &IGM, ArrayR
 static void sanityCheckStdlib(IRGenModule &IGM) {
   if (!IGM.getSwiftModule()->isStdlibModule()) return;
 
-  // Only run the sanity check when we're building the real stdlib.
+  // Only run the soundness check when we're building the real stdlib.
   if (!lookupSimple(IGM.getSwiftModule(), { "String" })) return;
 
   if (!IGM.ObjCInterop) return;

lib/LLVMPasses/LLVMMergeFunctions.cpp

@@ -463,7 +463,7 @@ class SwiftMergeFunctions {
   }
 
   /// Checks the rules of order relation introduced among functions set.
-  /// Returns true, if sanity check has been passed, and false if failed.
+  /// Returns true, if soundness check has been passed, and false if failed.
   bool doSanityCheck(std::vector<WeakTrackingVH> &Worklist);
 
   /// Updates the numUnhandledCallees of all user functions of the equivalence

lib/RemoteAST/RemoteAST.cpp

@@ -116,11 +116,11 @@ class RemoteASTContextImpl {
                                  unsigned ordinal) = 0;
   Result<uint64_t>
   getOffsetOfMember(Type type, RemoteAddress optMetadata, StringRef memberName){
-    // Sanity check: obviously invalid arguments.
+    // Soundness check: obviously invalid arguments.
     if (!type || memberName.empty())
       return Result<uint64_t>::emplaceFailure(Failure::BadArgument);
 
-    // Sanity check: if the caller gave us a dependent type, there's no way
+    // Soundness check: if the caller gave us a dependent type, there's no way
     // we can handle that.
     if (type->hasTypeParameter() || type->hasArchetype())
       return Result<uint64_t>::emplaceFailure(Failure::DependentArgument);

lib/SILGen/LValue.h

@@ -428,7 +428,7 @@ class LValue {
   }
 
   /// Pop the last component off this LValue unsafely. Validates that the
-  /// component is of kind \p kind as a sanity check.
+  /// component is of kind \p kind as a soundness check.
   ///
   /// Please be careful when using this!
   void unsafelyDropLastComponent(PathComponent::KindTy kind) & {

lib/SILGen/SILGenLValue.cpp

@@ -4259,7 +4259,7 @@ LValue SILGenLValue::visitOpenExistentialExpr(OpenExistentialExpr *e,
   // Visit the subexpression.
   LValue lv = visitRec(e->getSubExpr(), accessKind, options);
 
-  // Sanity check that we did see the OpaqueValueExpr.
+  // Soundness check that we did see the OpaqueValueExpr.
   assert(SGF.OpaqueValueExprs.count(e->getOpaqueValue()) == 0 &&
          "opened existential not removed?");
   return lv;

lib/SILGen/SILGenType.cpp

@@ -549,7 +549,7 @@ class SILGenConformance : public SILGenWitnessTable<SILGenConformance> {
         wt->convertToDefinition(Entries, ConditionalConformances, Serialized);
 
         // Since we had a declaration before, its linkage should be external,
-        // ensure that we have a compatible linkage for sanity. *NOTE* we are ok
+        // ensure that we have a compatible linkage for soundness. *NOTE* we are ok
         // with both being shared since we do not have a shared_external
         // linkage.
         assert(stripExternalFromLinkage(wt->getLinkage()) == Linkage &&

lib/SILOptimizer/Analysis/AccessSummaryAnalysis.cpp

@@ -148,7 +148,7 @@ void AccessSummaryAnalysis::processArgument(FunctionInfo *info,
 }
 
 #ifndef NDEBUG
-/// Sanity check to make sure that a noescape partial apply is only ultimately
+/// Soundness check to make sure that a noescape partial apply is only ultimately
 /// used by directly calling it or passing it as argument, but not using it as a
 /// partial_apply callee.
 ///

lib/SILOptimizer/LoopTransforms/ArrayPropertyOpt.cpp

@@ -323,7 +323,7 @@ class ArrayPropertiesAnalysis {
       return false;
     }
 
-    // Otherwise, all of our users are sane. The array does not escape.
+    // Otherwise, all of our users are sound. The array does not escape.
     return true;
   }
 

lib/SILOptimizer/Mandatory/DiagnoseStaticExclusivity.cpp

@@ -921,7 +921,7 @@ static void checkForViolationsAtInstruction(SILInstruction &I,
     return;
   }
 
-  // Sanity check to make sure entries are properly removed.
+  // Soundness check to make sure entries are properly removed.
   assert((!isa<ReturnInst>(&I) || State.Accesses->empty())
          && "Entries were not properly removed?!");
 }
@@ -936,7 +936,7 @@ static void checkStaticExclusivity(SILFunction &Fn, PostOrderFunctionInfo *PO,
   //      accesses must have begun in the same order on all edges. This ensures
   //      consistent diagnostics across changes to the exploration of the CFG.
   //    - On return from a function there are no in-progress accesses. This
-  //      enables a sanity check for lean analysis state at function exit.
+  //      enables a soundness check for lean analysis state at function exit.
   //    - Each end_access instruction corresponds to exactly one begin access
   //      instruction. (This is encoded in the EndAccessInst itself)
   //    - begin_access arguments cannot be basic block arguments.

lib/SILOptimizer/Mandatory/Differentiation.cpp

@@ -566,7 +566,7 @@ emitDerivativeFunctionReference(
             diag::autodiff_external_nondifferentiable_function);
         return llvm::None;
       }
-      // Sanity check passed. Create a new differentiability witness and
+      // Soundness check passed. Create a new differentiability witness and
       // canonicalize it.
       GenericSignature contextualDerivativeGenSig = GenericSignature();
       if (invoker.getKind() ==

lib/SILOptimizer/Mandatory/MoveOnlyUtils.cpp

@@ -633,7 +633,7 @@ bool siloptimizer::eliminateTemporaryAllocationsFromLet(
 
     // Then check that our final use and initialCAI are in the same block and
     // that all instructions in between them with side-effects are instructions
-    // that we visited. This is a sanity check.
+    // that we visited. This is a soundness check.
     if (finalUse->getParentBlock() != initialCAI->getParent() ||
         llvm::any_of(llvm::make_range(initialCAI->getIterator(),
                                       finalUse->getUser()->getIterator()),

lib/SILOptimizer/Transforms/AccessEnforcementDom.cpp

@@ -396,7 +396,7 @@ bool DominatedAccessRemoval::checkDominatedAccess(
   // location as the key.
   //
   // Cast this DomAccessStorage back to a plain storage location. The
-  // pass-specific bits will be ignored, but reset them anyway for sanity.
+  // pass-specific bits will be ignored, but reset them anyway for soundness.
   AccessStorage storage = static_cast<AccessStorage>(currDomStorage);
   storage.resetSubclassData();
   auto iterAndInserted =

lib/SILOptimizer/Utils/CanonicalizeOSSALifetime.cpp

@@ -1164,7 +1164,7 @@ bool CanonicalizeOSSALifetime::computeLiveness() {
   //
   // NotifyWillBeDeleted will not work because copy rewriting removes operands
   // before deleting instructions. Also prohibit setUse callbacks just because
-  // that would simply be insane.
+  // that would simply be unsound.
   assert(!getCallbacks().notifyWillBeDeletedFunc
          && !getCallbacks().setUseValueFunc && "unsupported");
 

lib/Sema/AssociatedTypeInference.cpp

@@ -1396,7 +1396,7 @@ AssociatedTypeInference::inferTypeWitnessesViaValueWitnesses(
 
     // Skip operator requirements, because they match globally and
     // therefore tend to cause deduction mismatches.
-    // FIXME: If we had some basic sanity checking of Self, we might be able to
+    // FIXME: If we had some basic soundness checking of Self, we might be able to
     // use these.
     if (auto func = dyn_cast<FuncDecl>(req)) {
       if (func->isOperator() || isa<AccessorDecl>(func))

lib/Sema/CSDiagnostics.cpp

@@ -2008,7 +2008,7 @@ bool TrailingClosureAmbiguityFailure::diagnoseAsNote() {
     const ParameterList *paramList = callee->getParameters();
     const ParamDecl *param = paramList->getArray().back();
 
-    // Sanity-check that the trailing closure corresponds to this parameter.
+    // Soundness-check that the trailing closure corresponds to this parameter.
     if (!param->hasInterfaceType() ||
         !param->getInterfaceType()->is<AnyFunctionType>())
       return false;

lib/Sema/CSRanking.cpp

@@ -1373,7 +1373,7 @@ SolutionCompareResult ConstraintSystem::compareSolutions(
     // If either of the types still contains type variables, we can't
     // compare them.
     // FIXME: This is really unfortunate. More type variable sharing
-    // (when it's sane) would help us do much better here.
+    // (when it's sound) would help us do much better here.
     if (type1->hasTypeVariable() || type2->hasTypeVariable()) {
       identical = false;
       continue;

lib/Sema/DebuggerTestingTransform.cpp

@@ -58,7 +58,7 @@ unsigned DiscriminatorFinder::getNextDiscriminator() {
 
 namespace {
 
-/// Instrument decls with sanity-checks which the debugger can evaluate.
+/// Instrument decls with soundness-checks which the debugger can evaluate.
 class DebuggerTestingTransform : public ASTWalker {
   ASTContext &Ctx;
   DiscriminatorFinder &DF;
@@ -309,7 +309,7 @@ void swift::performDebuggerTestingTransform(SourceFile &SF) {
   for (Decl *D : SF.getTopLevelDecls())
     D->walk(DF);
 
-  // Instrument the decls with checkExpect() sanity-checks.
+  // Instrument the decls with checkExpect() soundness-checks.
   for (Decl *D : SF.getTopLevelDecls()) {
     DebuggerTestingTransform Transform{D->getASTContext(), DF};
     D->walk(Transform);

lib/Sema/TypeCheckAccess.cpp

@@ -877,7 +877,7 @@ class AccessControlChecker : public AccessControlCheckerBase,
             ty = superclass;
         return ty->getAnyNominal() == superclassDecl;
       });
-      // Sanity check: we couldn't find the superclass for whatever reason
+      // Soundness check: we couldn't find the superclass for whatever reason
       // (possibly because it's synthetic or something), so don't bother
       // checking it.
       if (superclassLocIter == inheritedEntries.end())
@@ -1611,7 +1611,7 @@ class UsableFromInlineChecker : public AccessControlCheckerBase,
             ty = superclass;
         return ty->getAnyNominal() == superclassDecl;
       });
-      // Sanity check: we couldn't find the superclass for whatever reason
+      // Soundness check: we couldn't find the superclass for whatever reason
       // (possibly because it's synthetic or something), so don't bother
       // checking it.
       if (superclassLocIter == inheritedEntries.end())

stdlib/public/Concurrency/TaskStatus.cpp

@@ -803,7 +803,7 @@ static void swift_taskGroup_attachChildImpl(TaskGroup *group,
   withStatusRecordLock(parent, [&](ActiveTaskStatus parentStatus) {
     group->addChildTask(child);
 
-    // After getting parent's status record lock, do some sanity checks to
+    // After getting parent's status record lock, do some soundness checks to
     // see if parent task or group has state changes that need to be
     // propagated to the child.
     //

stdlib/public/RemoteInspection/TypeRefBuilder.cpp

@@ -590,7 +590,7 @@ TypeRefBuilder::ReflectionTypeDescriptorFinder::getMultiPayloadEnumInfo(
   for (auto Info : ReflectionInfos) {
     for (auto MultiPayloadEnumDescriptor : Info.MultiPayloadEnum) {
 
-      // Assert that descriptor size is sane...
+      // Assert that descriptor size is sound...
       assert(MultiPayloadEnumDescriptor->getContentsSizeInWords() >= 1);
       // We're limited to 64k of spare bits mask...
       assert(MultiPayloadEnumDescriptor->getContentsSizeInWords() < 16384);

stdlib/public/core/ArrayBuffer.swift

@@ -100,7 +100,7 @@ extension _ArrayBuffer {
   /// Returns `true` if this buffer's storage is uniquely referenced;
   /// otherwise, returns `false`.
   ///
-  /// This function should only be used for internal sanity checks.
+  /// This function should only be used for internal soundness checks.
   /// To guard a buffer mutation, use `beginCOWMutation`.
   @inlinable
   internal mutating func isUniquelyReferenced() -> Bool {