Skip to content

Commit ab7a7f5

Browse files
committed
Update docs
1 parent 0b9666b commit ab7a7f5

File tree

153 files changed

+10595
-0
lines changed

Some content is hidden

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

153 files changed

+10595
-0
lines changed

Mirage.Block.html

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<link rel="stylesheet" href="style.css" type="text/css">
5+
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6+
<link rel="Start" href="index.html">
7+
<link rel="previous" href="Mirage.Direct_kv_ro.html">
8+
<link rel="next" href="Mirage.Fat.html">
9+
<link rel="Up" href="Mirage.html">
10+
<link title="Index of types" rel=Appendix href="index_types.html">
11+
<link title="Index of values" rel=Appendix href="index_values.html">
12+
<link title="Index of modules" rel=Appendix href="index_modules.html">
13+
<link title="Index of module types" rel=Appendix href="index_module_types.html">
14+
<link title="Mirage" rel="Chapter" href="Mirage.html">
15+
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
16+
<link title="V1" rel="Chapter" href="V1.html">
17+
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.Block</title>
18+
</head>
19+
<body>
20+
<div class="navbar"><a class="pre" href="Mirage.Direct_kv_ro.html" title="Mirage.Direct_kv_ro">Previous</a>
21+
&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
22+
&nbsp;<a class="post" href="Mirage.Fat.html" title="Mirage.Fat">Next</a>
23+
</div>
24+
<h1>Module <a href="type_Mirage.Block.html">Mirage.Block</a></h1>
25+
26+
<pre><span class="keyword">module</span> Block: <code class="type"><a href="Mirage.CONFIGURABLE.html">CONFIGURABLE</a></code><code class="type"> </code></pre><div class="info module top">
27+
Implementation of raw block device.<br>
28+
</div>
29+
<hr width="100%">
30+
<br>
31+
Signature for configurable devices.<br>
32+
33+
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
34+
<div class="info ">
35+
Abstract type for configurable devices.<br>
36+
</div>
37+
38+
39+
<pre><span id="VALname"><span class="keyword">val</span> name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
40+
Return the unique variable name holding the state of the given
41+
device.<br>
42+
</div>
43+
44+
<pre><span id="VALmodule_name"><span class="keyword">val</span> module_name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
45+
Return the name of the module implementing the given device.<br>
46+
</div>
47+
48+
<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
49+
Return the list of OPAM packages which needs to be installed to
50+
use the given device.<br>
51+
</div>
52+
53+
<pre><span id="VALlibraries"><span class="keyword">val</span> libraries</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
54+
Return the list of ocamlfind libraries to link with the
55+
application to use the given device.<br>
56+
</div>
57+
58+
<pre><span id="VALconfigure"><span class="keyword">val</span> configure</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
59+
Configure the given device.<br>
60+
</div>
61+
62+
<pre><span id="VALclean"><span class="keyword">val</span> clean</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
63+
Clean all the files generated to use the given device.<br>
64+
</div>
65+
66+
<pre><span id="VALupdate_path"><span class="keyword">val</span> update_path</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string -> <a href="Mirage.CONFIGURABLE.html#TYPEt">t</a></code></pre><div class="info ">
67+
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
68+
the the prefix <code class="code">root</code>.<br>
69+
</div>
70+
</body></html>

Mirage.CONFIGURABLE.html

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<link rel="stylesheet" href="style.css" type="text/css">
5+
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6+
<link rel="Start" href="index.html">
7+
<link rel="Up" href="Mirage.html">
8+
<link title="Index of types" rel=Appendix href="index_types.html">
9+
<link title="Index of values" rel=Appendix href="index_values.html">
10+
<link title="Index of modules" rel=Appendix href="index_modules.html">
11+
<link title="Index of module types" rel=Appendix href="index_module_types.html">
12+
<link title="Mirage" rel="Chapter" href="Mirage.html">
13+
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
14+
<link title="V1" rel="Chapter" href="V1.html">
15+
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.CONFIGURABLE</title>
16+
</head>
17+
<body>
18+
<div class="navbar">&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
19+
&nbsp;</div>
20+
<h1>Module type <a href="type_Mirage.CONFIGURABLE.html">Mirage.CONFIGURABLE</a></h1>
21+
22+
<pre><span class="keyword">module type</span> CONFIGURABLE = <code class="code">sig</code> <a href="Mirage.CONFIGURABLE.html">..</a> <code class="code">end</code></pre><hr width="100%">
23+
<br>
24+
Signature for configurable devices.<br>
25+
26+
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
27+
<div class="info ">
28+
Abstract type for configurable devices.<br>
29+
</div>
30+
31+
32+
<pre><span id="VALname"><span class="keyword">val</span> name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
33+
Return the unique variable name holding the state of the given
34+
device.<br>
35+
</div>
36+
37+
<pre><span id="VALmodule_name"><span class="keyword">val</span> module_name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
38+
Return the name of the module implementing the given device.<br>
39+
</div>
40+
41+
<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
42+
Return the list of OPAM packages which needs to be installed to
43+
use the given device.<br>
44+
</div>
45+
46+
<pre><span id="VALlibraries"><span class="keyword">val</span> libraries</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
47+
Return the list of ocamlfind libraries to link with the
48+
application to use the given device.<br>
49+
</div>
50+
51+
<pre><span id="VALconfigure"><span class="keyword">val</span> configure</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
52+
Configure the given device.<br>
53+
</div>
54+
55+
<pre><span id="VALclean"><span class="keyword">val</span> clean</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
56+
Clean all the files generated to use the given device.<br>
57+
</div>
58+
59+
<pre><span id="VALupdate_path"><span class="keyword">val</span> update_path</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string -> <a href="Mirage.CONFIGURABLE.html#TYPEt">t</a></code></pre><div class="info ">
60+
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
61+
the the prefix <code class="code">root</code>.<br>
62+
</div>
63+
</body></html>

Mirage.Channel_over_TCP.html

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<link rel="stylesheet" href="style.css" type="text/css">
5+
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6+
<link rel="Start" href="index.html">
7+
<link rel="previous" href="Mirage.STACKV4_socket.html">
8+
<link rel="next" href="Mirage.HTTP.html">
9+
<link rel="Up" href="Mirage.html">
10+
<link title="Index of types" rel=Appendix href="index_types.html">
11+
<link title="Index of values" rel=Appendix href="index_values.html">
12+
<link title="Index of modules" rel=Appendix href="index_modules.html">
13+
<link title="Index of module types" rel=Appendix href="index_module_types.html">
14+
<link title="Mirage" rel="Chapter" href="Mirage.html">
15+
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
16+
<link title="V1" rel="Chapter" href="V1.html">
17+
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.Channel_over_TCP</title>
18+
</head>
19+
<body>
20+
<div class="navbar"><a class="pre" href="Mirage.STACKV4_socket.html" title="Mirage.STACKV4_socket">Previous</a>
21+
&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
22+
&nbsp;<a class="post" href="Mirage.HTTP.html" title="Mirage.HTTP">Next</a>
23+
</div>
24+
<h1>Functor <a href="type_Mirage.Channel_over_TCP.html">Mirage.Channel_over_TCP</a></h1>
25+
26+
<pre><span class="keyword">module</span> Channel_over_TCP: <div class="sig_block"><code class="code">functor (</code><code class="code">V</code><code class="code"> : </code><code class="code">sig</code><div class="sig_block">
27+
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
28+
29+
</div><code class="code">end</code><code class="code">) -&gt; </code><code class="type"><a href="Mirage.CONFIGURABLE.html">CONFIGURABLE</a></code><code class="type"> </code></div></pre><table border="0" cellpadding="3" width="100%">
30+
<tr>
31+
<td align="left" valign="top" width="1%%"><b>Parameters: </b></td>
32+
<td>
33+
<table class="paramstable">
34+
<tr>
35+
<td align="center" valign="top" width="15%">
36+
<code>V</code></td>
37+
<td align="center" valign="top">:</td>
38+
<td><code class="type">sig type t end</code>
39+
</table>
40+
</td>
41+
</tr>
42+
</table>
43+
<hr width="100%">
44+
<br>
45+
Signature for configurable devices.<br>
46+
47+
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
48+
<div class="info ">
49+
Abstract type for configurable devices.<br>
50+
</div>
51+
52+
53+
<pre><span id="VALname"><span class="keyword">val</span> name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
54+
Return the unique variable name holding the state of the given
55+
device.<br>
56+
</div>
57+
58+
<pre><span id="VALmodule_name"><span class="keyword">val</span> module_name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
59+
Return the name of the module implementing the given device.<br>
60+
</div>
61+
62+
<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
63+
Return the list of OPAM packages which needs to be installed to
64+
use the given device.<br>
65+
</div>
66+
67+
<pre><span id="VALlibraries"><span class="keyword">val</span> libraries</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
68+
Return the list of ocamlfind libraries to link with the
69+
application to use the given device.<br>
70+
</div>
71+
72+
<pre><span id="VALconfigure"><span class="keyword">val</span> configure</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
73+
Configure the given device.<br>
74+
</div>
75+
76+
<pre><span id="VALclean"><span class="keyword">val</span> clean</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
77+
Clean all the files generated to use the given device.<br>
78+
</div>
79+
80+
<pre><span id="VALupdate_path"><span class="keyword">val</span> update_path</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string -> <a href="Mirage.CONFIGURABLE.html#TYPEt">t</a></code></pre><div class="info ">
81+
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
82+
the the prefix <code class="code">root</code>.<br>
83+
</div>
84+
</body></html>

Mirage.Clock.html

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<link rel="stylesheet" href="style.css" type="text/css">
5+
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6+
<link rel="Start" href="index.html">
7+
<link rel="previous" href="Mirage.Io_page.html">
8+
<link rel="next" href="Mirage.Time.html">
9+
<link rel="Up" href="Mirage.html">
10+
<link title="Index of types" rel=Appendix href="index_types.html">
11+
<link title="Index of values" rel=Appendix href="index_values.html">
12+
<link title="Index of modules" rel=Appendix href="index_modules.html">
13+
<link title="Index of module types" rel=Appendix href="index_module_types.html">
14+
<link title="Mirage" rel="Chapter" href="Mirage.html">
15+
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
16+
<link title="V1" rel="Chapter" href="V1.html">
17+
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.Clock</title>
18+
</head>
19+
<body>
20+
<div class="navbar"><a class="pre" href="Mirage.Io_page.html" title="Mirage.Io_page">Previous</a>
21+
&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
22+
&nbsp;<a class="post" href="Mirage.Time.html" title="Mirage.Time">Next</a>
23+
</div>
24+
<h1>Module <a href="type_Mirage.Clock.html">Mirage.Clock</a></h1>
25+
26+
<pre><span class="keyword">module</span> Clock: <code class="type"><a href="Mirage.CONFIGURABLE.html">CONFIGURABLE</a></code><code class="type"> </code></pre><div class="info module top">
27+
Implementation of clocks.<br>
28+
</div>
29+
<hr width="100%">
30+
<br>
31+
Signature for configurable devices.<br>
32+
33+
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
34+
<div class="info ">
35+
Abstract type for configurable devices.<br>
36+
</div>
37+
38+
39+
<pre><span id="VALname"><span class="keyword">val</span> name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
40+
Return the unique variable name holding the state of the given
41+
device.<br>
42+
</div>
43+
44+
<pre><span id="VALmodule_name"><span class="keyword">val</span> module_name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
45+
Return the name of the module implementing the given device.<br>
46+
</div>
47+
48+
<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
49+
Return the list of OPAM packages which needs to be installed to
50+
use the given device.<br>
51+
</div>
52+
53+
<pre><span id="VALlibraries"><span class="keyword">val</span> libraries</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
54+
Return the list of ocamlfind libraries to link with the
55+
application to use the given device.<br>
56+
</div>
57+
58+
<pre><span id="VALconfigure"><span class="keyword">val</span> configure</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
59+
Configure the given device.<br>
60+
</div>
61+
62+
<pre><span id="VALclean"><span class="keyword">val</span> clean</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
63+
Clean all the files generated to use the given device.<br>
64+
</div>
65+
66+
<pre><span id="VALupdate_path"><span class="keyword">val</span> update_path</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string -> <a href="Mirage.CONFIGURABLE.html#TYPEt">t</a></code></pre><div class="info ">
67+
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
68+
the the prefix <code class="code">root</code>.<br>
69+
</div>
70+
</body></html>

Mirage.Console.html

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<link rel="stylesheet" href="style.css" type="text/css">
5+
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6+
<link rel="Start" href="index.html">
7+
<link rel="previous" href="Mirage.Random.html">
8+
<link rel="next" href="Mirage.Crunch.html">
9+
<link rel="Up" href="Mirage.html">
10+
<link title="Index of types" rel=Appendix href="index_types.html">
11+
<link title="Index of values" rel=Appendix href="index_values.html">
12+
<link title="Index of modules" rel=Appendix href="index_modules.html">
13+
<link title="Index of module types" rel=Appendix href="index_module_types.html">
14+
<link title="Mirage" rel="Chapter" href="Mirage.html">
15+
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
16+
<link title="V1" rel="Chapter" href="V1.html">
17+
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.Console</title>
18+
</head>
19+
<body>
20+
<div class="navbar"><a class="pre" href="Mirage.Random.html" title="Mirage.Random">Previous</a>
21+
&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
22+
&nbsp;<a class="post" href="Mirage.Crunch.html" title="Mirage.Crunch">Next</a>
23+
</div>
24+
<h1>Module <a href="type_Mirage.Console.html">Mirage.Console</a></h1>
25+
26+
<pre><span class="keyword">module</span> Console: <code class="type"><a href="Mirage.CONFIGURABLE.html">CONFIGURABLE</a></code><code class="type"> </code></pre><div class="info module top">
27+
Implementation of consoles.<br>
28+
</div>
29+
<hr width="100%">
30+
<br>
31+
Signature for configurable devices.<br>
32+
33+
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
34+
<div class="info ">
35+
Abstract type for configurable devices.<br>
36+
</div>
37+
38+
39+
<pre><span id="VALname"><span class="keyword">val</span> name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
40+
Return the unique variable name holding the state of the given
41+
device.<br>
42+
</div>
43+
44+
<pre><span id="VALmodule_name"><span class="keyword">val</span> module_name</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string</code></pre><div class="info ">
45+
Return the name of the module implementing the given device.<br>
46+
</div>
47+
48+
<pre><span id="VALpackages"><span class="keyword">val</span> packages</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
49+
Return the list of OPAM packages which needs to be installed to
50+
use the given device.<br>
51+
</div>
52+
53+
<pre><span id="VALlibraries"><span class="keyword">val</span> libraries</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string list</code></pre><div class="info ">
54+
Return the list of ocamlfind libraries to link with the
55+
application to use the given device.<br>
56+
</div>
57+
58+
<pre><span id="VALconfigure"><span class="keyword">val</span> configure</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
59+
Configure the given device.<br>
60+
</div>
61+
62+
<pre><span id="VALclean"><span class="keyword">val</span> clean</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
63+
Clean all the files generated to use the given device.<br>
64+
</div>
65+
66+
<pre><span id="VALupdate_path"><span class="keyword">val</span> update_path</span> : <code class="type"><a href="Mirage.CONFIGURABLE.html#TYPEt">t</a> -> string -> <a href="Mirage.CONFIGURABLE.html#TYPEt">t</a></code></pre><div class="info ">
67+
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
68+
the the prefix <code class="code">root</code>.<br>
69+
</div>
70+
</body></html>

0 commit comments

Comments
 (0)