Skip to content

Commit

Permalink
Update ocaml-version doc to 3.6.4.
Browse files Browse the repository at this point in the history
  • Loading branch information
benmandrew committed Jan 24, 2024
1 parent f61f2d7 commit 9f74f6b
Show file tree
Hide file tree
Showing 47 changed files with 989 additions and 151 deletions.
4 changes: 2 additions & 2 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>index</title>
<link rel="stylesheet" href="./odoc.css"/>
<link rel="stylesheet" href="./odoc.support/odoc.css"/>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1.0"/>
</head>
Expand All @@ -11,7 +11,7 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="ocaml-version/index.html">ocaml-version</a> <span class="version">v3.6.3</span></li>
<li><a href="ocaml-version/index.html">ocaml-version</a> <span class="version">v3.6.4</span></li>
</ol>
</div>
</main>
Expand Down
Empty file.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/ocaml-version/Ocaml_version/Has/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Has (ocaml-version.Ocaml_version.Has)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../index.html">ocaml-version</a> &#x00BB; <a href="../index.html">Ocaml_version</a> &#x00BB; Has</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_version.Has</span></code></h1><p>Test whether a release has a given feature.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-bytes"><a href="#val-bytes" class="anchor"></a><code><span><span class="keyword">val</span> bytes : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>bytes t</code> will return <code>true</code> if that release has a <a href="#val-bytes"><code>bytes</code></a> type. Note that opam provides a <code>bytes</code> compatibility package for older releases.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-arch"><a href="#val-arch" class="anchor"></a><code><span><span class="keyword">val</span> arch : <span><a href="../index.html#type-arch">arch</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>arch a t</code> will return <code>true</code> if architecture <code>a</code> is supported on release <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-options_packages"><a href="#val-options_packages" class="anchor"></a><code><span><span class="keyword">val</span> options_packages : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>options_packages t</code> will return true if the release <code>t</code> uses <code>ocaml-option-*</code> packages in opam-repository, rather than +variant packages</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-multicore"><a href="#val-multicore" class="anchor"></a><code><span><span class="keyword">val</span> multicore : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>multicore t</code> will return true if the release <code>t</code> has a multicore OCaml fork available for it. This requires the <a href="https://github.com/ocaml-multicore/multicore-opam">https://github.com/ocaml-multicore/multicore-opam</a> opam switch to be added before the package is available.</p><p>Note that the multicore variants changed between 4.10 and 4.12, and this function returns true for any of them.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Has (ocaml-version.Ocaml_version.Has)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../index.html">ocaml-version</a> &#x00BB; <a href="../index.html">Ocaml_version</a> &#x00BB; Has</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_version.Has</span></code></h1><p>Test whether a release has a given feature.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-bytes"><a href="#val-bytes" class="anchor"></a><code><span><span class="keyword">val</span> bytes : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>bytes t</code> will return <code>true</code> if that release has a <a href="#val-bytes"><code>bytes</code></a> type. Note that opam provides a <code>bytes</code> compatibility package for older releases.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-arch"><a href="#val-arch" class="anchor"></a><code><span><span class="keyword">val</span> arch : <span><a href="../index.html#type-arch">arch</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>arch a t</code> will return <code>true</code> if architecture <code>a</code> is supported on release <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-options_packages"><a href="#val-options_packages" class="anchor"></a><code><span><span class="keyword">val</span> options_packages : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>options_packages t</code> will return true if the release <code>t</code> uses <code>ocaml-option-*</code> packages in opam-repository, rather than +variant packages</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-multicore"><a href="#val-multicore" class="anchor"></a><code><span><span class="keyword">val</span> multicore : <span><a href="../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>multicore t</code> will return true if the release <code>t</code> has a multicore OCaml fork available for it. This requires the <a href="https://github.com/ocaml-multicore/multicore-opam">https://github.com/ocaml-multicore/multicore-opam</a> opam switch to be added before the package is available.</p><p>Note that the multicore variants changed between 4.10 and 4.12, and this function returns true for any of them.</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion doc/ocaml-version/Ocaml_version/Opam/V2/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>V2 (ocaml-version.Ocaml_version.Opam.V2)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../index.html">ocaml-version</a> &#x00BB; <a href="../../index.html">Ocaml_version</a> &#x00BB; <a href="../index.html">Opam</a> &#x00BB; V2</nav><header class="odoc-preamble"><h1>Module <code><span>Opam.V2</span></code></h1><p>Opam 2.0 functions</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-package"><a href="#val-package" class="anchor"></a><code><span><span class="keyword">val</span> package : <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string * string</span></code></div><div class="spec-doc"><p><code>package t</code> returns the <code>(name, version)</code> pair corresponding to the opam2 package for that compiler version.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-additional_packages"><a href="#val-additional_packages" class="anchor"></a><code><span><span class="keyword">val</span> additional_packages : <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>string list</span></span></code></div><div class="spec-doc"><p><code>additional_packages t</code> returns the list of opam packages which need to be installed in addition to the <a href="#val-package"><code>package</code></a> <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name"><a href="#val-name" class="anchor"></a><code><span><span class="keyword">val</span> name : <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p><code>name t</code> returns the opam2 package for that compiler version.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-variant_switch"><a href="#val-variant_switch" class="anchor"></a><code><span><span class="keyword">val</span> variant_switch : <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><a href="../../Configure_options/index.html#type-o">Configure_options.o</a> list</span> <span class="arrow">&#45;&gt;</span></span> <a href="../../index.html#type-t">t</a></span></code></div><div class="spec-doc"><p><code>variant_switch t cs</code> returns an OCaml version <code>t</code> whose variant version field reflects the configuration options in <code>cs</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-switches"><a href="#val-switches" class="anchor"></a><code><span><span class="keyword">val</span> switches : <span><a href="../../index.html#type-arch">arch</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../index.html#type-t">t</a> list</span></span></code></div><div class="spec-doc"><p><code>switches arch t</code> returns the list of opam switches that are available for that compiler and architecture combination. For example, an x86_64 one would yield a list that includes flambda and the flambda-with-frame-pointer combinations.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>V2 (ocaml-version.Ocaml_version.Opam.V2)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../../index.html">ocaml-version</a> &#x00BB; <a href="../../index.html">Ocaml_version</a> &#x00BB; <a href="../index.html">Opam</a> &#x00BB; V2</nav><header class="odoc-preamble"><h1>Module <code><span>Opam.V2</span></code></h1><p>Opam 2.0 functions</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-package"><a href="#val-package" class="anchor"></a><code><span><span class="keyword">val</span> package : <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string * string</span></code></div><div class="spec-doc"><p><code>package t</code> returns the <code>(name, version)</code> pair corresponding to the opam2 package for that compiler version.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-additional_packages"><a href="#val-additional_packages" class="anchor"></a><code><span><span class="keyword">val</span> additional_packages : <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>string list</span></span></code></div><div class="spec-doc"><p><code>additional_packages t</code> returns the list of opam packages which need to be installed in addition to the <a href="#val-package"><code>package</code></a> <code>t</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-name"><a href="#val-name" class="anchor"></a><code><span><span class="keyword">val</span> name : <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> string</span></code></div><div class="spec-doc"><p><code>name t</code> returns the opam2 package for that compiler version.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-variant_switch"><a href="#val-variant_switch" class="anchor"></a><code><span><span class="keyword">val</span> variant_switch : <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span><a href="../../Configure_options/index.html#type-o">Configure_options.o</a> list</span> <span class="arrow">&#45;&gt;</span></span> <a href="../../index.html#type-t">t</a></span></code></div><div class="spec-doc"><p><code>variant_switch t cs</code> returns an OCaml version <code>t</code> whose variant version field reflects the configuration options in <code>cs</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-switches"><a href="#val-switches" class="anchor"></a><code><span><span class="keyword">val</span> switches : <span><a href="../../index.html#type-arch">arch</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../index.html#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../index.html#type-t">t</a> list</span></span></code></div><div class="spec-doc"><p><code>switches arch t</code> returns the list of opam switches that are available for that compiler and architecture combination. For example, an x86_64 one would yield a list that includes flambda and the flambda-with-frame-pointer combinations.</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion doc/ocaml-version/Ocaml_version/Opam/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opam (ocaml-version.Ocaml_version.Opam)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../index.html">ocaml-version</a> &#x00BB; <a href="../index.html">Ocaml_version</a> &#x00BB; Opam</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_version.Opam</span></code></h1><p>Opam compiler switches. These are available from the public <a href="https://github.com/ocaml/opam-repository">opam-repository</a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-V2"><a href="#module-V2" class="anchor"></a><code><span><span class="keyword">module</span> <a href="V2/index.html">V2</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Opam 2.0 functions</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opam (ocaml-version.Ocaml_version.Opam)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a><a href="../../index.html">ocaml-version</a> &#x00BB; <a href="../index.html">Ocaml_version</a> &#x00BB; Opam</nav><header class="odoc-preamble"><h1>Module <code><span>Ocaml_version.Opam</span></code></h1><p>Opam compiler switches. These are available from the public <a href="https://github.com/ocaml/opam-repository">opam-repository</a>.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-V2"><a href="#module-V2" class="anchor"></a><code><span><span class="keyword">module</span> <a href="V2/index.html">V2</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Opam 2.0 functions</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion doc/ocaml-version/Ocaml_version/Releases/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit 9f74f6b

Please sign in to comment.