Move comment explaining our Options to OptionsList.h
authorkeith_miller@apple.com <keith_miller@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 18 Sep 2019 03:23:28 +0000 (03:23 +0000)
committerkeith_miller@apple.com <keith_miller@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 18 Sep 2019 03:23:28 +0000 (03:23 +0000)
https://bugs.webkit.org/show_bug.cgi?id=201891

Rubber-stamped by Mark Lam.

We moved the list so we should move the comment.

* runtime/Options.h:
* runtime/OptionsList.h:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@250021 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/JavaScriptCore/ChangeLog
Source/JavaScriptCore/runtime/Options.h
Source/JavaScriptCore/runtime/OptionsList.h

index 6b567e3..8bfadca 100644 (file)
@@ -1,5 +1,17 @@
 2019-09-17  Keith Miller  <keith_miller@apple.com>
 
+        Move comment explaining our Options to OptionsList.h
+        https://bugs.webkit.org/show_bug.cgi?id=201891
+
+        Rubber-stamped by Mark Lam.
+
+        We moved the list so we should move the comment.
+
+        * runtime/Options.h:
+        * runtime/OptionsList.h:
+
+2019-09-17  Keith Miller  <keith_miller@apple.com>
+
         Elide unnecessary moves in Air O0
         https://bugs.webkit.org/show_bug.cgi?id=201703
 
index 03ad2a0..58c9b3e 100644 (file)
@@ -39,34 +39,6 @@ using WTF::StringBuilder;
 
 namespace JSC {
 
-// How do JSC VM options work?
-// ===========================
-// The FOR_EACH_JSC_OPTION() macro below defines a list of all JSC options in use,
-// along with their types and default values. The options values are actually
-// realized as an array of OptionEntry elements in JSC::Config.
-//
-//     Options::initialize() will initialize the array of options values with
-// the defaults specified in FOR_EACH_JSC_OPTION() below. After that, the values can
-// be programmatically read and written to using an accessor method with the
-// same name as the option. For example, the option "useJIT" can be read and
-// set like so:
-//
-//     bool jitIsOn = Options::useJIT();  // Get the option value.
-//     Options::useJIT() = false;         // Sets the option value.
-//
-//     If you want to tweak any of these values programmatically for testing
-// purposes, you can do so in Options::initialize() after the default values
-// are set.
-//
-//     Alternatively, you can override the default values by specifying
-// environment variables of the form: JSC_<name of JSC option>.
-//
-// Note: Options::initialize() tries to ensure some sanity on the option values
-// which are set by doing some range checks, and value corrections. These
-// checks are done after the option values are set. If you alter the option
-// values after the sanity checks (for your own testing), then you're liable to
-// ensure that the new values set are sane and reasonable for your own run.
-
 #if PLATFORM(IOS_FAMILY)
 #define MAXIMUM_NUMBER_OF_FTL_COMPILER_THREADS 2
 #else
index 31b321a..0b9fb83 100644 (file)
 
 namespace JSC {
 
-#define FOR_EACH_JSC_OPTION(v) \
+// How do JSC VM options work?
+// ===========================
+// The FOR_EACH_JSC_OPTION() macro below defines a list of all JSC options in use,
+// along with their types and default values. The options values are actually
+// realized as an array of OptionEntry elements in JSC::Config.
+//
+//     Options::initialize() will initialize the array of options values with
+// the defaults specified in FOR_EACH_JSC_OPTION() below. After that, the values can
+// be programmatically read and written to using an accessor method with the
+// same name as the option. For example, the option "useJIT" can be read and
+// set like so:
+//
+//     bool jitIsOn = Options::useJIT();  // Get the option value.
+//     Options::useJIT() = false;         // Sets the option value.
+//
+//     If you want to tweak any of these values programmatically for testing
+// purposes, you can do so in Options::initialize() after the default values
+// are set.
+//
+//     Alternatively, you can override the default values by specifying
+// environment variables of the form: JSC_<name of JSC option>.
+//
+// Note: Options::initialize() tries to ensure some sanity on the option values
+// which are set by doing some range checks, and value corrections. These
+// checks are done after the option values are set. If you alter the option
+// values after the sanity checks (for your own testing), then you're liable to
+// ensure that the new values set are sane and reasonable for your own run.
+
+#define FOR_EACH_JSC_OPTION(v)                                          \
     v(Bool, useKernTCSM, true, Normal, "Note: this needs to go before other options since they depend on this value.") \
     v(Bool, validateOptions, false, Normal, "crashes if mis-typed JSC options were passed to the VM") \
     v(Unsigned, dumpOptions, 0, Normal, "dumps JSC options (0 = None, 1 = Overridden only, 2 = All, 3 = Verbose)") \