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

[DOC] Improve docs for GC.compact

Browse Source
This commit is contained in:
Peter Zhu 2024-01-15 11:27:31 -05:00
parent 5e61cc26c9
commit cc7b19e048
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
gc.c
View File

@ -11108,16 +11108,16 @@ heap_check_moved_i(void *vstart, void *vend, size_t stride, void *data)
/*
* call-seq:
* GC.compact
* GC.compact -> hash
*
* This function compacts objects together in Ruby's heap. It eliminates
* This function compacts objects together in Ruby's heap. It eliminates
* unused space (or fragmentation) in the heap by moving objects in to that
* unused space. This function returns a hash which contains statistics about
* which objects were moved. See <tt>GC.latest_compact_info</tt> for details
* about compaction statistics.
* unused space.
*
* This method is implementation specific and not expected to be implemented
* in any implementation besides MRI.
* The returned +hash+ contains statistics about the objects that were moved;
* see GC.latest_compact_info.
*
* This method is only expected to work on CRuby.
*
* To test whether \GC compaction is supported, use the idiom:
*