Merge pull request #39982 from xymus/serialization-low-level-error

xymus · web-flow · commit 1bc87abe9d6a · 2021-11-01T17:35:37.000-07:00
[Serialization] Reword error message on memory corruption or format failures
diff --git a/lib/Serialization/ModuleFile.h b/lib/Serialization/ModuleFile.h
@@ -344,9 +344,12 @@ class ModuleFile
     fatal(expected.takeError());
   }
 
+  /// Report an unexpected format error that could happen only from a memory-level
+  /// inconsistency. Please prefer passing an error to `fatal(llvm::Error error)` when possible.
   [[noreturn]] void fatal() const {
     fatal(llvm::make_error<llvm::StringError>(
-        "(see \"While...\" info below)", llvm::inconvertibleErrorCode()));
+        "Memory corruption or serialization format inconsistency.",
+        llvm::inconvertibleErrorCode()));
   }
 
   /// Outputs information useful for diagnostics to \p out

Original file line number	Diff line number	Diff line change
`@@ -344,9 +344,12 @@ class ModuleFile`
`344`	`344`	`fatal(expected.takeError());`
`345`	`345`	`}`
`346`	`346`
	`347`	`+ /// Report an unexpected format error that could happen only from a memory-level`
	`348`	+ /// inconsistency. Please prefer passing an error to `fatal(llvm::Error error)` when possible.
`347`	`349`	`[[noreturn]] void fatal() const {`
`348`	`350`	`fatal(llvm::make_error<llvm::StringError>(`
`349`		`- "(see \"While...\" info below)", llvm::inconvertibleErrorCode()));`
	`351`	`+ "Memory corruption or serialization format inconsistency.",`
	`352`	`+ llvm::inconvertibleErrorCode()));`
`350`	`353`	`}`
`351`	`354`
`352`	`355`	`/// Outputs information useful for diagnostics to \p out`