kotovalexarian-likes-github/ruby--ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
Code Releases Activity

Add option hash doc for GC stats.

Browse source 
Add a description about optional hash objects for GC.stat and
GC.latest_gc_info. [Bug #14408]

The patch is provided by sho-h (Sho Hashimoto).
Thank you so much.
This commit is contained in:
Koichi Sasada 2020-01-15 10:20:19 +09:00
parent 8c3efa4940
commit eb4c86a698
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
gc.rb
View file

@ -140,6 +140,10 @@ module GC
# The contents of the hash are implementation specific and may be changed in
# the future.
#
# If the optional argument, hash, is given,
# it is overwritten and returned.
# This is intended to avoid probe effect.
#
# This method is only expected to work on C Ruby.
def self.stat hash_or_key = nil
__builtin_gc_stat hash_or_key
@ -151,6 +155,10 @@ module GC
# GC.latest_gc_info(:major_by) -> :malloc
#
# Returns information about the most recent garbage collection.
#
# If the optional argument, hash, is given,
# it is overwritten and returned.
# This is intended to avoid probe effect.
def self.latest_gc_info hash_or_key = nil
__builtin_gc_latest_gc_info hash_or_key
end