* ext/objspace/objspace.c: improve wording and remove duplicated comment.

Based on a patch by Dave Goodchild. [Fixes GH-299]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@41061 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
eregon 2013-06-04 14:09:25 +00:00
parent d893082841
commit 71b6077a53
2 changed files with 14 additions and 20 deletions

View File

@ -1,3 +1,8 @@
Tue Jun 4 23:08:42 2013 Benoit Daloze <eregontp@gmail.com>
* ext/objspace/objspace.c: improve wording and remove duplicated comment.
Based on a patch by Dave Goodchild. [Fixes GH-299]
Tue Jun 4 18:41:47 2013 Tanaka Akira <akr@fsij.org> Tue Jun 4 18:41:47 2013 Tanaka Akira <akr@fsij.org>
* bignum.c (bitlength_bdigit): Fix an off-by-one error. * bignum.c (bitlength_bdigit): Fix an off-by-one error.

View File

@ -12,17 +12,6 @@
**********************************************************************/ **********************************************************************/
/* objspace library extends ObjectSpace module and add several
* methods to get internal statistic information about
* object/memory management.
*
* Generally, you *SHOULD NOT*use this library if you do not know
* about the MRI implementation. Mainly, this library is for (memory)
* profiler developers and MRI developers who need to know how MRI
* memory usage.
*
*/
#include <ruby/ruby.h> #include <ruby/ruby.h>
#include <ruby/st.h> #include <ruby/st.h>
#include <ruby/io.h> #include <ruby/io.h>
@ -721,13 +710,13 @@ collect_values(st_data_t key, st_data_t value, st_data_t data)
* [MRI specific feature] Return all reachable objects from `obj'. * [MRI specific feature] Return all reachable objects from `obj'.
* *
* This method returns all reachable objects from `obj'. * This method returns all reachable objects from `obj'.
* If `obj' has references two or more references to same object `x', * If `obj' has two or more references to the same object `x',
* them returned array only include one `x' object. * then returned array only includes one `x' object.
* If `obj' is non-markable (non-heap management) object such as * If `obj' is a non-markable (non-heap management) object such as
* true, false, nil, symbols and Fixnums (and Flonum) them it simply * true, false, nil, symbols and Fixnums (and Flonum) then it simply
* returns nil. * returns nil.
* *
* If `obj' has references to internal object, then it returns * If `obj' has references to an internal object, then it returns
* instances of `ObjectSpace::InternalObjectWrapper' class. * instances of `ObjectSpace::InternalObjectWrapper' class.
* This object contains a reference to an internal object and * This object contains a reference to an internal object and
* you can check the type of internal object with `type' method. * you can check the type of internal object with `type' method.
@ -738,7 +727,7 @@ collect_values(st_data_t key, st_data_t value, st_data_t data)
* *
* With this method, you can find memory leaks. * With this method, you can find memory leaks.
* *
* This method is not expected to work except C Ruby. * This method is not expected to work except in C Ruby.
* *
* Example: * Example:
* ObjectSpace.reachable_objects_from(['a', 'b', 'c']) * ObjectSpace.reachable_objects_from(['a', 'b', 'c'])
@ -782,13 +771,13 @@ reachable_objects_from(VALUE self, VALUE obj)
void Init_object_tracing(VALUE rb_mObjSpace); void Init_object_tracing(VALUE rb_mObjSpace);
void Init_gc_hook(VALUE rb_mObjSpace); void Init_gc_hook(VALUE rb_mObjSpace);
/* objspace library extends ObjectSpace module and add several /* The objspace library extends the ObjectSpace module and adds several
* methods to get internal statistic information about * methods to get internal statistic information about
* object/memory management. * object/memory management.
* *
* Generally, you *SHOULD NOT*use this library if you do not know * Generally, you *SHOULD NOT* use this library if you do not know
* about the MRI implementation. Mainly, this library is for (memory) * about the MRI implementation. Mainly, this library is for (memory)
* profiler developers and MRI developers who need to know how MRI * profiler developers and MRI developers who need to know about MRI
* memory usage. * memory usage.
*/ */