Skip to content

Commit

Permalink
[DOC] Improve docs for GC.latest_compact_info
Browse files Browse the repository at this point in the history
  • Loading branch information
peterzhu2118 committed Feb 20, 2024
1 parent 35fdf1a commit 97d4363
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions gc.c
Expand Up @@ -10897,16 +10897,20 @@ gc_update_references(rb_objspace_t *objspace)
*
* Returns information about object moved in the most recent \GC compaction.
*
* The returned +hash+ has the following keys:
* The returned +hash+ contains the following keys:
*
* - +:considered+: a hash containing the type of the object as the key and
* the number of objects of that type that were considered for movement.
* - +:moved+: a hash containing the type of the object as the key and the
* number of objects of that type that were actually moved.
* - +:moved_up+: a hash containing the type of the object as the key and the
* number of objects of that type that were increased in size.
* - +:moved_down+: a hash containing the type of the object as the key and
* the number of objects of that type that were decreased in size.
* [considered]
* Hash containing the type of the object as the key and the number of
* objects of that type that were considered for movement.
* [moved]
* Hash containing the type of the object as the key and the number of
* objects of that type that were actually moved.
* [moved_up]
* Hash containing the type of the object as the key and the number of
* objects of that type that were increased in size.
* [moved_down]
* Hash containing the type of the object as the key and the number of
* objects of that type that were decreased in size.
*
* Some objects can't be moved (due to pinning) so these numbers can be used to
* calculate compaction efficiency.
Expand Down

0 comments on commit 97d4363

Please sign in to comment.