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

Typo fixes [doc]

Browse source
This commit is contained in:
Marc-Andre Lafortune 2021-01-12 23:30:47 -05:00
parent f48edc28dd
commit 65787f18b9
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
doc/ractor.md
View file

@ -530,13 +530,13 @@ The following objects are shareable.
* Frozen native objects * Frozen native objects
* Numeric objects: `Float`, `Complex`, `Rational`, big integers (`T_BIGNUM` in internal) * Numeric objects: `Float`, `Complex`, `Rational`, big integers (`T_BIGNUM` in internal)
* All Symbols. * All Symbols.
* Frozen `String` and `Regexp` objects (their instance variables should refer only sharable objects) * Frozen `String` and `Regexp` objects (their instance variables should refer only shareable objects)
* Class, Module objects (`T_CLASS`, `T_MODULE` and `T_ICLASS` in internal) * Class, Module objects (`T_CLASS`, `T_MODULE` and `T_ICLASS` in internal)
* `Ractor` and other special objects which care about synchronization. * `Ractor` and other special objects which care about synchronization.
Implementation: Now shareable objects (`RVALUE`) have `FL_SHAREABLE` flag. This flag can be added lazily. Implementation: Now shareable objects (`RVALUE`) have `FL_SHAREABLE` flag. This flag can be added lazily.
To make sharable objects, `Ractor.make_shareable(obj)` method is provided. In this case, try to make sharaeble by freezing `obj` and recursively travasible objects. This method accepts `copy:` keyword (default value is false).`Ractor.make_sharable(obj, copy: true)` tries to make a deep copy of `obj` and make the copied object sharable. To make shareable objects, `Ractor.make_shareable(obj)` method is provided. In this case, try to make sharaeble by freezing `obj` and recursively travasible objects. This method accepts `copy:` keyword (default value is false).`Ractor.make_shareable(obj, copy: true)` tries to make a deep copy of `obj` and make the copied object shareable.
## Language changes to isolate unshareable objects between Ractors ## Language changes to isolate unshareable objects between Ractors
@ -659,16 +659,16 @@ rescue => e
end end
``` ```
To make multi-ractor supported library, the constants should only refer sharable objects. To make multi-ractor supported library, the constants should only refer shareable objects.
```ruby ```ruby
TABLE = {a: 'ko1', b: 'ko2', c: 'ko3'} TABLE = {a: 'ko1', b: 'ko2', c: 'ko3'}
``` ```
In this case, `TABLE` references an unshareable Hash object. So that other ractors can not refer `TABLE` constant. To make it shareable, we can use `Ractor.make_sharable()` like that. In this case, `TABLE` references an unshareable Hash object. So that other ractors can not refer `TABLE` constant. To make it shareable, we can use `Ractor.make_shareable()` like that.
```ruby ```ruby
TABLE = Ractor.make_sharable( {a: 'ko1', b: 'ko2', c: 'ko3'} ) TABLE = Ractor.make_shareable( {a: 'ko1', b: 'ko2', c: 'ko3'} )
``` ```
To make it easy, Ruby 3.0 introduced new `shareable_constant_value` Directive. To make it easy, Ruby 3.0 introduced new `shareable_constant_value` Directive.
@ -677,19 +677,19 @@ To make it easy, Ruby 3.0 introduced new `shareable_constant_value` Directive.
shareable_constant_value: literal shareable_constant_value: literal
TABLE = {a: 'ko1', b: 'ko2', c: 'ko3'} TABLE = {a: 'ko1', b: 'ko2', c: 'ko3'}
#=> Same as: TABLE = Ractor.make_sharable( {a: 'ko1', b: 'ko2', c: 'ko3'} ) #=> Same as: TABLE = Ractor.make_shareable( {a: 'ko1', b: 'ko2', c: 'ko3'} )
``` ```
`shareable_constant_value` directive accepts the following modes (descriptions use the example: `CONST = expr`): `shareable_constant_value` directive accepts the following modes (descriptions use the example: `CONST = expr`):
* none: Do nothing. Same as: `CONST = expr` * none: Do nothing. Same as: `CONST = expr`
* literal: * literal:
* if `expr` is consites of literals, replaced to `CONST = Ractor.make_sharable(expr)`. * if `expr` is consites of literals, replaced to `CONST = Ractor.make_shareable(expr)`.
* otherwise: replaced to `CONST = expr.tap{|o| raise unless Ractor.shareable?}`. * otherwise: replaced to `CONST = expr.tap{|o| raise unless Ractor.shareable?}`.
* experimental_everything: replaced to `CONST = Ractor.make_sharable(expr)`. * experimental_everything: replaced to `CONST = Ractor.make_shareable(expr)`.
* experimental_copy: replaced to `CONST = Ractor.make_sharable(expr, copy: true)`. * experimental_copy: replaced to `CONST = Ractor.make_shareable(expr, copy: true)`.
Except the `none` mode (default), it is guaranteed that the assigned constants refer to only sharable objects. Except the `none` mode (default), it is guaranteed that the assigned constants refer to only shareable objects.
See [doc/syntax/comment.rdoc](syntax/comment.rdoc) for more details. See [doc/syntax/comment.rdoc](syntax/comment.rdoc) for more details.