1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

Fix docs about movement for rb_gc_register_mark_object()

This API in fact pins objects passed to it. See vm.c:2546.
This commit is contained in:
Alan Wu 2020-11-25 17:33:09 -05:00
parent 984ba8de75
commit 56141d38a3
Notes: git 2020-12-02 05:23:50 +09:00

View file

@ -45,10 +45,8 @@ void rb_global_variable(VALUE *);
void rb_gc_unregister_address(VALUE *valptr);
/**
* Inform the garbage collector that `object` is a live Ruby object. Note that
* the garbage collector is free to move `object` and so it is not correct to
* save `object` into a C global constant and assume that it will always refer
* to the same Ruby object.
* Inform the garbage collector that `object` is a live Ruby object that should
* not be moved.
*
* See also: rb_gc_register_address()
*/