Bug 1549660 - Add units to GC parameter documentation r=jonco
authorPaul Bone <pbone@mozilla.com>
Wed, 08 May 2019 07:01:43 +0000
changeset 531831 3c314e0b2db01c75c490e8fbb2bae0bfb0f591c3
parent 531830 500d54b803cac1044a45d3205da10d3770d1eb0b
child 531832 831798cef995ab1dfc196e4adf68aba337a2950a
push id11265
push userffxbld-merge
push dateMon, 13 May 2019 10:53:39 +0000
treeherdermozilla-beta@77e0fe8dbdd3 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersjonco
bugs1549660
milestone68.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 1549660 - Add units to GC parameter documentation r=jonco Differential Revision: https://phabricator.services.mozilla.com/D30163
js/public/GCAPI.h
--- a/js/public/GCAPI.h
+++ b/js/public/GCAPI.h
@@ -155,58 +155,58 @@ typedef enum JSGCParamKey {
    *                non-incremental collections.
    *
    * The RHS of the equation above is calculated and sets
    * zone->threshold.gcTriggerBytes(). When usage.gcBytes() surpasses
    * threshold.gcTriggerBytes() for a zone, the zone may be scheduled for a GC.
    */
 
   /**
-   * GCs less than this far apart in time will be considered 'high-frequency
-   * GCs'.
+   * GCs less than this far apart in milliseconds will be considered
+   * 'high-frequency GCs'.
    *
    * Pref: javascript.options.mem.gc_high_frequency_time_limit_ms
    * Default: HighFrequencyThreshold
    */
   JSGC_HIGH_FREQUENCY_TIME_LIMIT = 11,
 
   /**
-   * Start of dynamic heap growth.
+   * Start of dynamic heap growth (MB).
    *
    * Pref: javascript.options.mem.gc_high_frequency_low_limit_mb
    * Default: HighFrequencyLowLimitBytes
    */
   JSGC_HIGH_FREQUENCY_LOW_LIMIT = 12,
 
   /**
-   * End of dynamic heap growth.
+   * End of dynamic heap growth (MB).
    *
    * Pref: javascript.options.mem.gc_high_frequency_high_limit_mb
    * Default: HighFrequencyHighLimitBytes
    */
   JSGC_HIGH_FREQUENCY_HIGH_LIMIT = 13,
 
   /**
-   * Upper bound of heap growth.
+   * Upper bound of heap growth percentage.
    *
    * Pref: javascript.options.mem.gc_high_frequency_heap_growth_max
    * Default: HighFrequencyHeapGrowthMax
    */
   JSGC_HIGH_FREQUENCY_HEAP_GROWTH_MAX = 14,
 
   /**
-   * Lower bound of heap growth.
+   * Lower bound of heap growth percentage.
    *
    * Pref: javascript.options.mem.gc_high_frequency_heap_growth_min
    * Default: HighFrequencyHeapGrowthMin
    */
   JSGC_HIGH_FREQUENCY_HEAP_GROWTH_MIN = 15,
 
   /**
-   * Heap growth for low frequency GCs.
+   * Heap growth percentage for low frequency GCs.
    *
    * Pref: javascript.options.mem.gc_low_frequency_heap_growth
    * Default: LowFrequencyHeapGrowth
    */
   JSGC_LOW_FREQUENCY_HEAP_GROWTH = 16,
 
   /**
    * If false, the heap growth factor is fixed at 3. If true, it is determined
@@ -280,17 +280,17 @@ typedef enum JSGCParamKey {
    *
    * Default: ZoneAllocThresholdFactorAvoidInterruptDefault
    * Pref: None
    */
   JSGC_ALLOCATION_THRESHOLD_FACTOR_AVOID_INTERRUPT = 26,
 
   /**
    * Attempt to run a minor GC in the idle time if the free space falls
-   * below this threshold.
+   * below this number of bytes.
    *
    * Default: NurseryChunkUsableSize / 4
    * Pref: None
    */
   JSGC_NURSERY_FREE_THRESHOLD_FOR_IDLE_COLLECTION = 27,
 
   /**
    * If this percentage of the nursery is tenured, then proceed to examine which