Bug 1162789 - Add a comment explaining why mForm is not set to null d…

…uring unlink Comment-only, landed on a CLOSED TREE, DONTBUILD
dothq · May 8, 2015 · 15c042b · 15c042b
1 parent 21ce8b6
commit 15c042b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/dom/html/HTMLFormControlsCollection.cpp b/dom/html/HTMLFormControlsCollection.cpp
@@ -121,6 +121,9 @@ HTMLFormControlsCollection::FlushPendingNotifications()
 NS_IMPL_CYCLE_COLLECTION_CLASS(HTMLFormControlsCollection)
 
 NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(HTMLFormControlsCollection)
+  // Note: We intentionally don't set tmp->mForm to nullptr here, since doing
+  // so may result in crashes because of inconsistent null-checking after the
+  // object gets unlinked.
   tmp->Clear();
   NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER
 NS_IMPL_CYCLE_COLLECTION_UNLINK_END