aboutsummaryrefslogtreecommitdiffstats
path: root/gc.c
diff options
context:
space:
mode:
authorakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2015-06-14 10:43:12 +0000
committerakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2015-06-14 10:43:12 +0000
commit5d81f0b6af0842e83913e993252e8942be3805bf (patch)
tree4a45bde4980ee0404f5c4e6e1e1ef02b10465c67 /gc.c
parent79c0d0687711f029470b4d8567695aab844246df (diff)
downloadruby-5d81f0b6af0842e83913e993252e8942be3805bf.tar.gz
[DOC]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@50891 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'gc.c')
-rw-r--r--gc.c8
1 files changed, 6 insertions, 2 deletions
diff --git a/gc.c b/gc.c
index ebd36cc3e8..38476df831 100644
--- a/gc.c
+++ b/gc.c
@@ -3117,8 +3117,12 @@ set_zero(st_data_t key, st_data_t val, st_data_t arg)
* }
*
* The contents of the returned hash are implementation specific.
- * It may be changed in future. The +:TOTAL+ key contains the count
- * of all currently allocated and previously freed objects.
+ * It may be changed in future.
+ *
+ * The keys starting with +:T_+ means live objects.
+ * For example, +:T_ARRAY+ is the number of arrays.
+ * +:FREE+ means object slots which is not used now.
+ * +:TOTAL+ means sum of above.
*
* If the optional argument +result_hash+ is given,
* it is overwritten and returned. This is intended to avoid probe effect.