Changeset 57016 in webkit for trunk/JavaScriptCore/wtf/Assertions.h

Timestamp:

Apr 2, 2010, 12:51:37 PM (15 years ago)

Author:

[email protected]

Message:

2010-04-02 Jeremy Moskovich <​[email protected]>

Reviewed by Geoffrey Garen.

Beef up documentation for ASSERT* and CRASH macros a bit.

​https://bugs.webkit.org/show_bug.cgi?id=36527

• wtf/Assertions.h:

File:

• trunk/JavaScriptCore/wtf/Assertions.h (modified) (3 diffs)

trunk/JavaScriptCore/wtf/Assertions.h

@@ -57 +57 @@
 
 #ifdef NDEBUG
+/* Disable ASSERT* macros in release mode. */
 #define ASSERTIONS_DISABLED_DEFAULT 1
 #else
@@ -149 +150 @@
 #endif
 
-/* CRASH -- gets us into the debugger or the crash reporter -- signals are ignored by the crash reporter so we must do better */
-
+/* CRASH() - Raises a fatal error resulting in program termination and triggering either the debugger or the crash reporter.
+
+   Use CRASH() in response to known, unrecoverable errors like out-of-memory.
+   Macro is enabled in both debug and release mode.
+   To test for unknown errors and verify assumptions, use ASSERT instead, to avoid impacting performance in release builds.
+
+   Signals are ignored by the crash reporter on OS X so we must do better.
+*/
 #ifndef CRASH
 #if OS(SYMBIAN)
@@ -165 +172 @@
 #endif
 
-/* ASSERT, ASSERT_NOT_REACHED, ASSERT_UNUSED */
+/* ASSERT, ASSERT_NOT_REACHED, ASSERT_UNUSED
+
+  These macros are compiled out of release builds.
+  Expressions inside them are evaluated in debug builds only.
+*/
 
 #if OS(WINCE) && !PLATFORM(TORCHMOBILE)