1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Document the :implementation key of GC.config

Browse Source
This commit is contained in:
Matt Valentine-House 2024-12-20 16:30:23 +00:00
parent 5d1fde06d4
commit 07724d7b6f
Notes: git 2024-12-20 19:47:20 +00:00 
Merged: https://github.com/ruby/ruby/pull/12411
1 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
gc.rb
View File

@ -257,7 +257,8 @@ module GC
# Configuration parameters are \GC implementation-specific and may change
# without notice.
#
# This method can be called without parameters to retrieve the current config.
# This method can be called without parameters to retrieve the current config
# as a +Hash+ with +Symbol+ keys.
#
# This method can also be called with a +Hash+ argument to assign values to
# valid config keys. Config keys missing from the passed +Hash+ will be left
@ -275,7 +276,23 @@ module GC
#
# This method is only expected to work on CRuby.
#
# Valid config keys for Ruby's default \GC implementation are:
# === \GC Implementation independent values
#
# The <code>GC.config</code> hash can also contain keys that are global and
# read-only. These keys are not specific to any one \GC library implementation
# and attempting to read them will raise +ArgumentError+.
#
# There is currently only one global, read-only key:
#
# [implementation]
# Returns a +String+ containing the name of the currently loaded \GC library,
# if one has been loaded using +RUBY_GC_LIBRARY+, and "default" in all other
# cases
#
# === \GC Implementation specific values
#
# \GC libraries are expected to document their own configuration. Valid keys
# for Ruby's default \GC implementation are:
#
# [rgengc_allow_full_mark]
# Controls whether the \GC is allowed to run a full mark (young & old objects).