diff options
author | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2015-04-14 00:01:03 +0000 |
---|---|---|
committer | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2015-04-14 00:01:03 +0000 |
commit | 9075d3ef51c0e1240cd2c97c3602146d86eb9901 (patch) | |
tree | 1c122e7266963948b106c1488ff59f51cf1602a6 /gc.c | |
parent | 6b162ccf2f8bdfece95b72d20b996582fade047f (diff) | |
download | ruby-9075d3ef51c0e1240cd2c97c3602146d86eb9901.tar.gz |
* gc.c: [DOC] Improve documentation for ObjectSpace.count_objects
with regards to `:TOTAL` key, with patch by @schneems [Fixes GH-871]
https://github.com/ruby/ruby/pull/871 [Bug #11067] [ci skip]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@50303 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'gc.c')
-rw-r--r-- | gc.c | 10 |
1 files changed, 8 insertions, 2 deletions
@@ -3056,7 +3056,7 @@ set_zero(st_data_t key, st_data_t val, st_data_t arg) * call-seq: * ObjectSpace.count_objects([result_hash]) -> hash * - * Counts objects for each type. + * Counts all objects grouped by type. * * It returns a hash, such as: * { @@ -3068,11 +3068,17 @@ 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. + * It may be changed in future. The +:TOTAL+ key contains the count + * of all currently allocated and previously freed objects. * * If the optional argument +result_hash+ is given, * it is overwritten and returned. This is intended to avoid probe effect. * + * h = {} + * ObjectSpace.count_objects(h) + * puts h + * # => { :TOTAL=>10000, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249 } + * * This method is only expected to work on C Ruby. * */ |