Skip to content

Commit fefda96

Browse files
committed
Update docs.
1 parent cf9d2e9 commit fefda96

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+94
-7
lines changed

4.x/.doctrees/bindings.doctree

20 Bytes
Binary file not shown.
846 Bytes
Binary file not shown.

4.x/.doctrees/environment.pickle

2.39 KB
Binary file not shown.

4.x/_sources/bindings.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Bindings
88
bindings/constructors
99
bindings/methods
1010
bindings/overloaded_methods
11+
bindings/gvl
1112
bindings/attributes
1213
bindings/enums
1314
bindings/constants

4.x/_sources/bindings/methods.rst.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,3 +175,6 @@ We define the ``to_s`` method to take a single parameter, self, which is an C++
175175

176176
The lambda function can take any number of additional parameters. It can be either a stateless or stateful lambda.
177177

178+
Global VM Lock (GVL)
179+
--------------------
180+
Refer to the :ref:`gvl` section to learn how to call C++ code without holding Ruby's GVL.

4.x/architecture.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@
221221
<li class="toctree-l2"><a class="reference internal" href="bindings/overloaded_methods.html#typedef">Typedef</a></li>
222222
<li class="toctree-l2"><a class="reference internal" href="bindings/overloaded_methods.html#method-resolution">Method Resolution</a></li>
223223
<li class="toctree-l2"><a class="reference internal" href="bindings/overloaded_methods.html#type-mapping">Type Mapping</a></li>
224+
<li class="toctree-l2"><a class="reference internal" href="bindings/gvl.html">Global Virtual Machine Lock (GVL)</a></li>
224225
<li class="toctree-l2"><a class="reference internal" href="bindings/attributes.html">Attributes</a></li>
225226
<li class="toctree-l2"><a class="reference internal" href="bindings/enums.html">Enums</a></li>
226227
<li class="toctree-l2"><a class="reference internal" href="bindings/constants.html">Constants</a></li>

4.x/architecture/enumerators.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@
221221
<li class="toctree-l2"><a class="reference internal" href="../bindings/overloaded_methods.html#typedef">Typedef</a></li>
222222
<li class="toctree-l2"><a class="reference internal" href="../bindings/overloaded_methods.html#method-resolution">Method Resolution</a></li>
223223
<li class="toctree-l2"><a class="reference internal" href="../bindings/overloaded_methods.html#type-mapping">Type Mapping</a></li>
224+
<li class="toctree-l2"><a class="reference internal" href="../bindings/gvl.html">Global Virtual Machine Lock (GVL)</a></li>
224225
<li class="toctree-l2"><a class="reference internal" href="../bindings/attributes.html">Attributes</a></li>
225226
<li class="toctree-l2"><a class="reference internal" href="../bindings/enums.html">Enums</a></li>
226227
<li class="toctree-l2"><a class="reference internal" href="../bindings/constants.html">Constants</a></li>

4.x/bindings.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@
221221
<li class="toctree-l2"><a class="reference internal" href="bindings/overloaded_methods.html#typedef">Typedef</a></li>
222222
<li class="toctree-l2"><a class="reference internal" href="bindings/overloaded_methods.html#method-resolution">Method Resolution</a></li>
223223
<li class="toctree-l2"><a class="reference internal" href="bindings/overloaded_methods.html#type-mapping">Type Mapping</a></li>
224+
<li class="toctree-l2"><a class="reference internal" href="bindings/gvl.html">Global Virtual Machine Lock (GVL)</a></li>
224225
<li class="toctree-l2"><a class="reference internal" href="bindings/attributes.html">Attributes</a></li>
225226
<li class="toctree-l2"><a class="reference internal" href="bindings/enums.html">Enums</a></li>
226227
<li class="toctree-l2"><a class="reference internal" href="bindings/constants.html">Constants</a></li>
@@ -345,6 +346,7 @@ <h1>Bindings<a class="headerlink" href="#bindings" title="Link to this heading">
345346
<li class="toctree-l2"><a class="reference internal" href="bindings/methods.html#keyword-arguments">Keyword Arguments</a></li>
346347
<li class="toctree-l2"><a class="reference internal" href="bindings/methods.html#return-self">Return Self</a></li>
347348
<li class="toctree-l2"><a class="reference internal" href="bindings/methods.html#lambda-functions">Lambda Functions</a></li>
349+
<li class="toctree-l2"><a class="reference internal" href="bindings/methods.html#global-vm-lock-gvl">Global VM Lock (GVL)</a></li>
348350
</ul>
349351
</li>
350352
<li class="toctree-l1"><a class="reference internal" href="bindings/overloaded_methods.html">Overloaded Methods</a></li>
@@ -354,6 +356,12 @@ <h1>Bindings<a class="headerlink" href="#bindings" title="Link to this heading">
354356
<li class="toctree-l1"><a class="reference internal" href="bindings/overloaded_methods.html#typedef">Typedef</a></li>
355357
<li class="toctree-l1"><a class="reference internal" href="bindings/overloaded_methods.html#method-resolution">Method Resolution</a></li>
356358
<li class="toctree-l1"><a class="reference internal" href="bindings/overloaded_methods.html#type-mapping">Type Mapping</a></li>
359+
<li class="toctree-l1"><a class="reference internal" href="bindings/gvl.html">Global Virtual Machine Lock (GVL)</a><ul>
360+
<li class="toctree-l2"><a class="reference internal" href="bindings/gvl.html#function-method-annotation">Function/Method Annotation</a></li>
361+
<li class="toctree-l2"><a class="reference internal" href="bindings/gvl.html#helper-method">Helper Method</a></li>
362+
<li class="toctree-l2"><a class="reference internal" href="bindings/gvl.html#acquire-the-gvl">Acquire the GVL</a></li>
363+
</ul>
364+
</li>
357365
<li class="toctree-l1"><a class="reference internal" href="bindings/attributes.html">Attributes</a></li>
358366
<li class="toctree-l1"><a class="reference internal" href="bindings/enums.html">Enums</a><ul>
359367
<li class="toctree-l2"><a class="reference internal" href="bindings/enums.html#nested-and-anonymous-enums">Nested and Anonymous Enums</a></li>

4.x/bindings/attributes.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head><meta charset="utf-8"/>
44
<meta name="viewport" content="width=device-width,initial-scale=1"/>
55
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
6-
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Enums" href="enums.html" /><link rel="prev" title="Overloaded Methods" href="overloaded_methods.html" />
6+
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Enums" href="enums.html" /><link rel="prev" title="Global Virtual Machine Lock (GVL)" href="gvl.html" />
77

88
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
99
<title>Attributes - Rice documentation</title>
@@ -221,6 +221,7 @@
221221
<li class="toctree-l2"><a class="reference internal" href="overloaded_methods.html#typedef">Typedef</a></li>
222222
<li class="toctree-l2"><a class="reference internal" href="overloaded_methods.html#method-resolution">Method Resolution</a></li>
223223
<li class="toctree-l2"><a class="reference internal" href="overloaded_methods.html#type-mapping">Type Mapping</a></li>
224+
<li class="toctree-l2"><a class="reference internal" href="gvl.html">Global Virtual Machine Lock (GVL)</a></li>
224225
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Attributes</a></li>
225226
<li class="toctree-l2"><a class="reference internal" href="enums.html">Enums</a></li>
226227
<li class="toctree-l2"><a class="reference internal" href="constants.html">Constants</a></li>
@@ -394,14 +395,14 @@
394395
</div>
395396
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
396397
</a>
397-
<a class="prev-page" href="overloaded_methods.html">
398+
<a class="prev-page" href="gvl.html">
398399
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
399400
<div class="page-info">
400401
<div class="context">
401402
<span>Previous</span>
402403
</div>
403404

404-
<div class="title">Overloaded Methods</div>
405+
<div class="title">Global Virtual Machine Lock (GVL)</div>
405406

406407
</div>
407408
</a>

4.x/bindings/buffers.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@
221221
<li class="toctree-l2"><a class="reference internal" href="overloaded_methods.html#typedef">Typedef</a></li>
222222
<li class="toctree-l2"><a class="reference internal" href="overloaded_methods.html#method-resolution">Method Resolution</a></li>
223223
<li class="toctree-l2"><a class="reference internal" href="overloaded_methods.html#type-mapping">Type Mapping</a></li>
224+
<li class="toctree-l2"><a class="reference internal" href="gvl.html">Global Virtual Machine Lock (GVL)</a></li>
224225
<li class="toctree-l2"><a class="reference internal" href="attributes.html">Attributes</a></li>
225226
<li class="toctree-l2"><a class="reference internal" href="enums.html">Enums</a></li>
226227
<li class="toctree-l2"><a class="reference internal" href="constants.html">Constants</a></li>

0 commit comments

Comments
 (0)