Skip to content

Commit ad14632

Browse files
BurdetteLamarpeterzhu2118
authored andcommitted
[DOC] Tweaks for GC.config
1 parent 62b5fe8 commit ad14632

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

gc.rb

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -260,11 +260,12 @@ def self.stat_heap heap_name = nil, hash_or_key = nil
260260
# GC.config -> hash
261261
# GC.config(hash_to_merge) -> merged_hash
262262
#
263-
# This method is expected to be defined, useful, and well-behaved
264-
# only in the CRuby implementation.
263+
# This method is implementation-specific to CRuby.
265264
#
266265
# Sets or gets information about the current \GC configuration.
267266
#
267+
# Configuration parameters are \GC implementation-specific and may change without notice.
268+
#
268269
# With no argument given, returns a hash containing the configuration:
269270
#
270271
# GC.config
@@ -302,13 +303,13 @@ def self.stat_heap heap_name = nil, hash_or_key = nil
302303
# Controls whether the \GC is allowed to run a full mark (young & old objects):
303304
#
304305
# - +true+ (default): \GC interleaves major and minor collections.
305-
# - +false+: \GC does not initiate a full marking cycle unless
306-
# explicitly directed by user code;
306+
# A flag is set to notify GC that a full mark has been requested.
307+
# This flag is accessible via GC.latest_gc_info(:need_major_by).
308+
# - +false+: \GC does not initiate a full marking cycle unless explicitly directed by user code;
307309
# see GC.start.
308-
#
309-
# Setting this parameter to +false+ disables young-to-old promotion .
310-
# For performance reasons, we recommended warming up the application using Process.warmup
311-
# before setting this parameter to +false+.
310+
# Setting this parameter to +false+ disables young-to-old promotion.
311+
# For performance reasons, we recommended warming up the application using Process.warmup
312+
# before setting this parameter to +false+.
312313
#
313314
def self.config hash = nil
314315
return Primitive.gc_config_get unless hash

0 commit comments

Comments
 (0)