Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
samoht committed Mar 16, 2015
1 parent 0b9666b commit ab7a7f5
Show file tree
Hide file tree
Showing 153 changed files with 10,595 additions and 0 deletions.
70 changes: 70 additions & 0 deletions Mirage.Block.html
@@ -0,0 +1,70 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Mirage.Direct_kv_ro.html">
<link rel="next" href="Mirage.Fat.html">
<link rel="Up" href="Mirage.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Mirage" rel="Chapter" href="Mirage.html">
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
<link title="V1" rel="Chapter" href="V1.html">
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.Block</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mirage.Direct_kv_ro.html" title="Mirage.Direct_kv_ro">Previous</a>
&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
&nbsp;<a class="post" href="Mirage.Fat.html" title="Mirage.Fat">Next</a>
</div>
<h1>Module <a href="type_Mirage.Block.html">Mirage.Block</a></h1>

<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">
Implementation of raw block device.<br>
</div>
<hr width="100%">
<br>
Signature for configurable devices.<br>

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
Abstract type for configurable devices.<br>
</div>


<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 ">
Return the unique variable name holding the state of the given
device.<br>
</div>

<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 ">
Return the name of the module implementing the given device.<br>
</div>

<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 ">
Return the list of OPAM packages which needs to be installed to
use the given device.<br>
</div>

<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 ">
Return the list of ocamlfind libraries to link with the
application to use the given device.<br>
</div>

<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 ">
Configure the given device.<br>
</div>

<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 ">
Clean all the files generated to use the given device.<br>
</div>

<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 ">
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
the the prefix <code class="code">root</code>.<br>
</div>
</body></html>
63 changes: 63 additions & 0 deletions Mirage.CONFIGURABLE.html
@@ -0,0 +1,63 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="Up" href="Mirage.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Mirage" rel="Chapter" href="Mirage.html">
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
<link title="V1" rel="Chapter" href="V1.html">
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.CONFIGURABLE</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
&nbsp;</div>
<h1>Module type <a href="type_Mirage.CONFIGURABLE.html">Mirage.CONFIGURABLE</a></h1>

<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%">
<br>
Signature for configurable devices.<br>

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
Abstract type for configurable devices.<br>
</div>


<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 ">
Return the unique variable name holding the state of the given
device.<br>
</div>

<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 ">
Return the name of the module implementing the given device.<br>
</div>

<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 ">
Return the list of OPAM packages which needs to be installed to
use the given device.<br>
</div>

<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 ">
Return the list of ocamlfind libraries to link with the
application to use the given device.<br>
</div>

<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 ">
Configure the given device.<br>
</div>

<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 ">
Clean all the files generated to use the given device.<br>
</div>

<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 ">
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
the the prefix <code class="code">root</code>.<br>
</div>
</body></html>
84 changes: 84 additions & 0 deletions Mirage.Channel_over_TCP.html
@@ -0,0 +1,84 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Mirage.STACKV4_socket.html">
<link rel="next" href="Mirage.HTTP.html">
<link rel="Up" href="Mirage.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Mirage" rel="Chapter" href="Mirage.html">
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
<link title="V1" rel="Chapter" href="V1.html">
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.Channel_over_TCP</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mirage.STACKV4_socket.html" title="Mirage.STACKV4_socket">Previous</a>
&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
&nbsp;<a class="post" href="Mirage.HTTP.html" title="Mirage.HTTP">Next</a>
</div>
<h1>Functor <a href="type_Mirage.Channel_over_TCP.html">Mirage.Channel_over_TCP</a></h1>

<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">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>

</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%">
<tr>
<td align="left" valign="top" width="1%%"><b>Parameters: </b></td>
<td>
<table class="paramstable">
<tr>
<td align="center" valign="top" width="15%">
<code>V</code></td>
<td align="center" valign="top">:</td>
<td><code class="type">sig type t end</code>
</table>
</td>
</tr>
</table>
<hr width="100%">
<br>
Signature for configurable devices.<br>

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
Abstract type for configurable devices.<br>
</div>


<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 ">
Return the unique variable name holding the state of the given
device.<br>
</div>

<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 ">
Return the name of the module implementing the given device.<br>
</div>

<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 ">
Return the list of OPAM packages which needs to be installed to
use the given device.<br>
</div>

<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 ">
Return the list of ocamlfind libraries to link with the
application to use the given device.<br>
</div>

<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 ">
Configure the given device.<br>
</div>

<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 ">
Clean all the files generated to use the given device.<br>
</div>

<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 ">
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
the the prefix <code class="code">root</code>.<br>
</div>
</body></html>
70 changes: 70 additions & 0 deletions Mirage.Clock.html
@@ -0,0 +1,70 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Mirage.Io_page.html">
<link rel="next" href="Mirage.Time.html">
<link rel="Up" href="Mirage.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Mirage" rel="Chapter" href="Mirage.html">
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
<link title="V1" rel="Chapter" href="V1.html">
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.Clock</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mirage.Io_page.html" title="Mirage.Io_page">Previous</a>
&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
&nbsp;<a class="post" href="Mirage.Time.html" title="Mirage.Time">Next</a>
</div>
<h1>Module <a href="type_Mirage.Clock.html">Mirage.Clock</a></h1>

<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">
Implementation of clocks.<br>
</div>
<hr width="100%">
<br>
Signature for configurable devices.<br>

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
Abstract type for configurable devices.<br>
</div>


<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 ">
Return the unique variable name holding the state of the given
device.<br>
</div>

<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 ">
Return the name of the module implementing the given device.<br>
</div>

<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 ">
Return the list of OPAM packages which needs to be installed to
use the given device.<br>
</div>

<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 ">
Return the list of ocamlfind libraries to link with the
application to use the given device.<br>
</div>

<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 ">
Configure the given device.<br>
</div>

<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 ">
Clean all the files generated to use the given device.<br>
</div>

<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 ">
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
the the prefix <code class="code">root</code>.<br>
</div>
</body></html>
70 changes: 70 additions & 0 deletions Mirage.Console.html
@@ -0,0 +1,70 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Mirage.Random.html">
<link rel="next" href="Mirage.Crunch.html">
<link rel="Up" href="Mirage.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Mirage" rel="Chapter" href="Mirage.html">
<link title="Mirage_misc" rel="Chapter" href="Mirage_misc.html">
<link title="V1" rel="Chapter" href="V1.html">
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>Mirage.Console</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Mirage.Random.html" title="Mirage.Random">Previous</a>
&nbsp;<a class="up" href="Mirage.html" title="Mirage">Up</a>
&nbsp;<a class="post" href="Mirage.Crunch.html" title="Mirage.Crunch">Next</a>
</div>
<h1>Module <a href="type_Mirage.Console.html">Mirage.Console</a></h1>

<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">
Implementation of consoles.<br>
</div>
<hr width="100%">
<br>
Signature for configurable devices.<br>

<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
Abstract type for configurable devices.<br>
</div>


<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 ">
Return the unique variable name holding the state of the given
device.<br>
</div>

<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 ">
Return the name of the module implementing the given device.<br>
</div>

<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 ">
Return the list of OPAM packages which needs to be installed to
use the given device.<br>
</div>

<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 ">
Return the list of ocamlfind libraries to link with the
application to use the given device.<br>
</div>

<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 ">
Configure the given device.<br>
</div>

<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 ">
Clean all the files generated to use the given device.<br>
</div>

<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 ">
<code class="code">update_path t root</code> prefixes all the path appearing in <code class="code">t</code> with
the the prefix <code class="code">root</code>.<br>
</div>
</body></html>

0 comments on commit ab7a7f5

Please sign in to comment.