Skip to content

Update manual for 5.1.1 #1639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 3 additions & 5 deletions site/releases/5.1/api/Gc.html
Original file line number Diff line number Diff line change
Expand Up @@ -587,13 +587,11 @@ <h1>Module <a href="type_Gc.html">Gc</a></h1>
<td class="typefieldcomment" align="left" valign="top"><code>(*</code></td><td class="typefieldcomment" align="left" valign="top"><div class="info ">
<div class="info-desc">
<p>Maximum amount of out-of-heap memory for each custom value
allocated in the minor heap. When a custom value is allocated
on the minor heap and holds more than this many bytes, only
this value is counted against <code class="code">custom_minor_ratio</code> and the
rest is directly counted against <code class="code">custom_major_ratio</code>.
allocated in the minor heap. Custom values that hold more
than this many bytes are allocated on the major heap.
Note: this only applies to values allocated with
<code class="code">caml_alloc_custom_mem</code> (e.g. bigarrays).
Default: 8192 bytes.</p>
Default: 70000 bytes.</p>
</div>
<ul class="info-attributes">
<li><b>Since</b> 4.08</li>
Expand Down
57 changes: 1 addition & 56 deletions site/releases/5.1/api/Marshal.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,29 +173,10 @@ <h1>Module <a href="type_Marshal.html">Marshal</a></h1>
</div>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom"><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top">
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top">
<code><span id="TYPEELTextern_flags.Compression"><span class="constructor">Compression</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top"><code>(*</code></td><td class="typefieldcomment" align="left" valign="top"><div class="info ">
<div class="info-desc">
<p>Compress the output if possible</p>
</div>
<ul class="info-attributes">
<li><b>Since</b> 5.1</li>
</ul>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom"><code>*)</code></td>
</tr></tbody></table>

<div class="info ">
<div class="info-desc">
<p>The flags to the <code class="code"><span class="constructor">Marshal</span>.to_*</code> functions below.</p>
</div>
</div>

<p>The flags to the <code class="code"><span class="constructor">Marshal</span>.to_*</code> functions below.</p>

<pre><span id="VALto_channel"><span class="keyword">val</span> to_channel</span> : <code class="type"><a href="Stdlib.html#TYPEout_channel">out_channel</a> -&gt; 'a -&gt; <a href="Marshal.html#TYPEextern_flags">extern_flags</a> list -&gt; unit</code></pre><div class="info ">
<div class="info-desc">
Expand Down Expand Up @@ -237,17 +218,6 @@ <h1>Module <a href="type_Marshal.html">Marshal</a></h1>
corresponding closure will create a new reference, different from
the global one.</p>

<p>If <code class="code">flags</code> contains <code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compression</span></code>, the marshaled data
representing value <code class="code">v</code> is compressed before being written to
channel <code class="code">chan</code>. Decompression takes place automatically in
the unmarshaling functions <a href="Stdlib.html#VALinput_value"><code class="code">input_value</code></a>, <a href="Marshal.html#VALfrom_channel"><code class="code"><span class="constructor">Marshal</span>.from_channel</code></a>,
<a href="Marshal.html#VALfrom_string"><code class="code"><span class="constructor">Marshal</span>.from_string</code></a>, etc. For large values <code class="code">v</code>, compression
typically reduces the size of marshaled data by a factor 2 to 4,
but slows down marshaling and, to a lesser extent, unmarshaling.
Compression is not supported on some platforms; in this case,
the <code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compression</span></code> flag is silently ignored and uncompressed
data is written to channel <code class="code">chan</code>.</p>

<p>If <code class="code">flags</code> contains <code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compat_32</span></code>, marshaling fails when
it encounters an integer value outside the range <code class="code">[-2{^30},&nbsp;2{^30}-1]</code>
of integers that are representable on a 32-bit platform. This
Expand All @@ -261,7 +231,6 @@ <h1>Module <a href="type_Marshal.html">Marshal</a></h1>
it has no effect if marshaling is performed on a 32-bit platform.</p>
</div>
<ul class="info-attributes">
<li><b>Before 5.1 </b> Compression mode was not supported</li>
<li><b>Raises</b> <code>Failure</code> if <code class="code">chan</code> is not in binary mode.</li>
</ul>
</div>
Expand Down Expand Up @@ -369,28 +338,4 @@ <h1>Module <a href="type_Marshal.html">Marshal</a></h1>
</div>
</div>

<pre><span id="VALcompression_supported"><span class="keyword">val</span> compression_supported</span> : <code class="type">unit -&gt; bool</code></pre><div class="info ">
<div class="info-desc">
<p>Indicates whether the compressed data format is supported.</p>

<p>If <code class="code"><span class="constructor">Marshal</span>.compression_supported()</code> is <code class="code"><span class="keyword">true</span></code>, compressed data
is unmarshaled safely by <a href="Stdlib.html#VALinput_value"><code class="code">input_value</code></a>, <a href="Marshal.html#VALfrom_channel"><code class="code"><span class="constructor">Marshal</span>.from_channel</code></a>,
<a href="Marshal.html#VALfrom_string"><code class="code"><span class="constructor">Marshal</span>.from_string</code></a> and related functions. Moreover, the
<code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compression</span></code> flag is honored by the <a href="Marshal.html#VALto_channel"><code class="code"><span class="constructor">Marshal</span>.to_channel</code></a>,
<a href="Marshal.html#VALto_string"><code class="code"><span class="constructor">Marshal</span>.to_string</code></a> and related functions, resulting in the
production of compressed data.</p>

<p>If <code class="code"><span class="constructor">Marshal</span>.compression_supported()</code> is <code class="code"><span class="keyword">false</span></code>, compressed data
causes <a href="Stdlib.html#VALinput_value"><code class="code">input_value</code></a>, <a href="Marshal.html#VALfrom_channel"><code class="code"><span class="constructor">Marshal</span>.from_channel</code></a>,
<a href="Marshal.html#VALfrom_string"><code class="code"><span class="constructor">Marshal</span>.from_string</code></a> and related functions to fail and a
<code class="code"><span class="constructor">Failure</span></code> exception to be raised. Moreover,
<a href="Marshal.html#VALto_channel"><code class="code"><span class="constructor">Marshal</span>.to_channel</code></a>, <a href="Marshal.html#VALto_string"><code class="code"><span class="constructor">Marshal</span>.to_string</code></a> and related functions
ignore the <code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compression</span></code> flag and produce uncompressed
data.</p>
</div>
<ul class="info-attributes">
<li><b>Since</b> 5.1</li>
</ul>
</div>

</div></body></html>
8 changes: 3 additions & 5 deletions site/releases/5.1/api/Stdlib.Gc.html
Original file line number Diff line number Diff line change
Expand Up @@ -582,13 +582,11 @@ <h1>Module <a href="type_Stdlib.Gc.html">Stdlib.Gc</a></h1>
<td class="typefieldcomment" align="left" valign="top"><code>(*</code></td><td class="typefieldcomment" align="left" valign="top"><div class="info ">
<div class="info-desc">
<p>Maximum amount of out-of-heap memory for each custom value
allocated in the minor heap. When a custom value is allocated
on the minor heap and holds more than this many bytes, only
this value is counted against <code class="code">custom_minor_ratio</code> and the
rest is directly counted against <code class="code">custom_major_ratio</code>.
allocated in the minor heap. Custom values that hold more
than this many bytes are allocated on the major heap.
Note: this only applies to values allocated with
<code class="code">caml_alloc_custom_mem</code> (e.g. bigarrays).
Default: 8192 bytes.</p>
Default: 70000 bytes.</p>
</div>
<ul class="info-attributes">
<li><b>Since</b> 4.08</li>
Expand Down
57 changes: 1 addition & 56 deletions site/releases/5.1/api/Stdlib.Marshal.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,29 +131,10 @@ <h1>Module <a href="type_Stdlib.Marshal.html">Stdlib.Marshal</a></h1>
</div>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom"><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top">
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top">
<code><span id="TYPEELTextern_flags.Compression"><span class="constructor">Compression</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top"><code>(*</code></td><td class="typefieldcomment" align="left" valign="top"><div class="info ">
<div class="info-desc">
<p>Compress the output if possible</p>
</div>
<ul class="info-attributes">
<li><b>Since</b> 5.1</li>
</ul>
</div>
</td><td class="typefieldcomment" align="left" valign="bottom"><code>*)</code></td>
</tr></tbody></table>

<div class="info ">
<div class="info-desc">
<p>The flags to the <code class="code"><span class="constructor">Marshal</span>.to_*</code> functions below.</p>
</div>
</div>

<p>The flags to the <code class="code"><span class="constructor">Marshal</span>.to_*</code> functions below.</p>

<pre><span id="VALto_channel"><span class="keyword">val</span> to_channel</span> : <code class="type"><a href="Stdlib.html#TYPEout_channel">out_channel</a> -&gt; 'a -&gt; <a href="Marshal.html#TYPEextern_flags">extern_flags</a> list -&gt; unit</code></pre><div class="info ">
<div class="info-desc">
Expand Down Expand Up @@ -195,17 +176,6 @@ <h1>Module <a href="type_Stdlib.Marshal.html">Stdlib.Marshal</a></h1>
corresponding closure will create a new reference, different from
the global one.</p>

<p>If <code class="code">flags</code> contains <code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compression</span></code>, the marshaled data
representing value <code class="code">v</code> is compressed before being written to
channel <code class="code">chan</code>. Decompression takes place automatically in
the unmarshaling functions <a href="Stdlib.html#VALinput_value"><code class="code">input_value</code></a>, <a href="Marshal.html#VALfrom_channel"><code class="code"><span class="constructor">Marshal</span>.from_channel</code></a>,
<a href="Marshal.html#VALfrom_string"><code class="code"><span class="constructor">Marshal</span>.from_string</code></a>, etc. For large values <code class="code">v</code>, compression
typically reduces the size of marshaled data by a factor 2 to 4,
but slows down marshaling and, to a lesser extent, unmarshaling.
Compression is not supported on some platforms; in this case,
the <code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compression</span></code> flag is silently ignored and uncompressed
data is written to channel <code class="code">chan</code>.</p>

<p>If <code class="code">flags</code> contains <code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compat_32</span></code>, marshaling fails when
it encounters an integer value outside the range <code class="code">[-2{^30},&nbsp;2{^30}-1]</code>
of integers that are representable on a 32-bit platform. This
Expand All @@ -219,7 +189,6 @@ <h1>Module <a href="type_Stdlib.Marshal.html">Stdlib.Marshal</a></h1>
it has no effect if marshaling is performed on a 32-bit platform.</p>
</div>
<ul class="info-attributes">
<li><b>Before 5.1 </b> Compression mode was not supported</li>
<li><b>Raises</b> <code>Failure</code> if <code class="code">chan</code> is not in binary mode.</li>
</ul>
</div>
Expand Down Expand Up @@ -327,28 +296,4 @@ <h1>Module <a href="type_Stdlib.Marshal.html">Stdlib.Marshal</a></h1>
</div>
</div>

<pre><span id="VALcompression_supported"><span class="keyword">val</span> compression_supported</span> : <code class="type">unit -&gt; bool</code></pre><div class="info ">
<div class="info-desc">
<p>Indicates whether the compressed data format is supported.</p>

<p>If <code class="code"><span class="constructor">Marshal</span>.compression_supported()</code> is <code class="code"><span class="keyword">true</span></code>, compressed data
is unmarshaled safely by <a href="Stdlib.html#VALinput_value"><code class="code">input_value</code></a>, <a href="Marshal.html#VALfrom_channel"><code class="code"><span class="constructor">Marshal</span>.from_channel</code></a>,
<a href="Marshal.html#VALfrom_string"><code class="code"><span class="constructor">Marshal</span>.from_string</code></a> and related functions. Moreover, the
<code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compression</span></code> flag is honored by the <a href="Marshal.html#VALto_channel"><code class="code"><span class="constructor">Marshal</span>.to_channel</code></a>,
<a href="Marshal.html#VALto_string"><code class="code"><span class="constructor">Marshal</span>.to_string</code></a> and related functions, resulting in the
production of compressed data.</p>

<p>If <code class="code"><span class="constructor">Marshal</span>.compression_supported()</code> is <code class="code"><span class="keyword">false</span></code>, compressed data
causes <a href="Stdlib.html#VALinput_value"><code class="code">input_value</code></a>, <a href="Marshal.html#VALfrom_channel"><code class="code"><span class="constructor">Marshal</span>.from_channel</code></a>,
<a href="Marshal.html#VALfrom_string"><code class="code"><span class="constructor">Marshal</span>.from_string</code></a> and related functions to fail and a
<code class="code"><span class="constructor">Failure</span></code> exception to be raised. Moreover,
<a href="Marshal.html#VALto_channel"><code class="code"><span class="constructor">Marshal</span>.to_channel</code></a>, <a href="Marshal.html#VALto_string"><code class="code"><span class="constructor">Marshal</span>.to_string</code></a> and related functions
ignore the <code class="code"><span class="constructor">Marshal</span>.<span class="constructor">Compression</span></code> flag and produce uncompressed
data.</p>
</div>
<ul class="info-attributes">
<li><b>Since</b> 5.1</li>
</ul>
</div>

</div></body></html>
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Arg_helper.Make.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Arg_helper.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Attr.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Cf.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Ci.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Cl.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Const.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Csig.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Cstr.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Ctf.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Cty.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
1 change: 1 addition & 0 deletions site/releases/5.1/api/compilerlibref/Ast_helper.Exp.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<link title="Build_path_prefix_map" rel="Chapter" href="Build_path_prefix_map.html">
<link title="Ccomp" rel="Chapter" href="Ccomp.html">
<link title="Clflags" rel="Chapter" href="Clflags.html">
<link title="Compression" rel="Chapter" href="Compression.html">
<link title="Config_boot" rel="Chapter" href="Config_boot.html">
<link title="Config_main" rel="Chapter" href="Config_main.html">
<link title="Config" rel="Chapter" href="Config.html">
Expand Down
Loading