Bug 1447284 - Fix comments on AutoSuppressGC class r=pbone
authorJon Coppeard <jcoppeard@mozilla.com>
Tue, 17 Apr 2018 15:32:03 +0200
changeset 414107 af53333e6e32bf01bfe243d10ba22b017eb9e0ad
parent 414106 a1ceebb96b78f8cfc82ad4d7fbcc972205213ce9
child 414108 f82556cd77c5d15a668c4f7f07df3919fffec56e
push id33858
push userncsoregi@mozilla.com
push dateTue, 17 Apr 2018 21:55:44 +0000
treeherdermozilla-central@d6eb5597d744 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerspbone
bugs1447284
milestone61.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1447284 - Fix comments on AutoSuppressGC class r=pbone
js/src/gc/GC.h
--- a/js/src/gc/GC.h
+++ b/js/src/gc/GC.h
@@ -159,20 +159,21 @@ static inline void
 VerifyBarriers(JSRuntime* rt, VerifierType type) {}
 
 static inline void
 MaybeVerifyBarriers(JSContext* cx, bool always = false) {}
 
 #endif
 
 /*
- * Instances of this class set the |JSRuntime::suppressGC| flag for the duration
- * that they are live. Use of this class is highly discouraged. Please carefully
- * read the comment in vm/Runtime.h above |suppressGC| and take all appropriate
- * precautions before instantiating this class.
+ * Instances of this class prevent GC while they are live by updating the
+ * |JSContext::suppressGC| counter. Use of this class is highly
+ * discouraged. Please carefully read the comment in vm/JSContext.h above
+ * |suppressGC| and take all appropriate precautions before instantiating this
+ * class.
  */
 class MOZ_RAII JS_HAZ_GC_SUPPRESSED AutoSuppressGC
 {
     int32_t& suppressGC_;
 
   public:
     explicit AutoSuppressGC(JSContext* cx);