Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
samoht committed Mar 19, 2015
1 parent f8d366b commit d6784bf
Show file tree
Hide file tree
Showing 24 changed files with 239 additions and 146 deletions.
12 changes: 6 additions & 6 deletions V1.BLOCK.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Sector-addressible block devices" rel="Section" href="#1_Sectoraddressibleblockdevices">
<title>V1.BLOCK</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.BLOCK</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.CONSOLE.html" title="V1.CONSOLE">Previous</a>
Expand All @@ -24,13 +23,14 @@
</div>
<h1>Module type <a href="type_V1.BLOCK.html">V1.BLOCK</a></h1>

<pre><span class="keyword">module type</span> BLOCK = <code class="code">sig</code> <a href="V1.BLOCK.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> BLOCK = <code class="code">sig</code> <a href="V1.BLOCK.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Sectoraddressibleblockdevices">Sector-addressible block devices</h1>
<p>

Operations on sector-addressible block devices, usually used
for persistent storage<br>
Operations on sector-addressible block devices, usually used
for persistent storage<br>
</div>
<hr width="100%">

<pre><span id="TYPEpage_aligned_buffer"><span class="keyword">type</span> <code class="type"></code>page_aligned_buffer</span> </pre>
<div class="info ">
Expand Down
12 changes: 6 additions & 6 deletions V1.CHANNEL.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Buffered byte-stream" rel="Section" href="#1_Bufferedbytestream">
<title>V1.CHANNEL</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.CHANNEL</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.STACKV4.html" title="V1.STACKV4">Previous</a>
Expand All @@ -24,13 +23,14 @@
</div>
<h1>Module type <a href="type_V1.CHANNEL.html">V1.CHANNEL</a></h1>

<pre><span class="keyword">module type</span> CHANNEL = <code class="code">sig</code> <a href="V1.CHANNEL.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> CHANNEL = <code class="code">sig</code> <a href="V1.CHANNEL.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Bufferedbytestream">Buffered byte-stream</h1>
<p>

Type of a buffered byte-stream that is attached to an unbuffered
flow (e.g. a TCPv4 connection).<br>
Type of a buffered byte-stream that is attached to an unbuffered
flow (e.g. a TCPv4 connection).<br>
</div>
<hr width="100%">

<pre><span id="TYPEbuffer"><span class="keyword">type</span> <code class="type"></code>buffer</span> </pre>
<div class="info ">
Expand Down
10 changes: 5 additions & 5 deletions V1.CLOCK.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Clock operations" rel="Section" href="#1_Clockoperations">
<title>V1.CLOCK</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.CLOCK</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.ENTROPY.html" title="V1.ENTROPY">Previous</a>
Expand All @@ -24,12 +23,13 @@
</div>
<h1>Module type <a href="type_V1.CLOCK.html">V1.CLOCK</a></h1>

<pre><span class="keyword">module type</span> CLOCK = <code class="code">sig</code> <a href="V1.CLOCK.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> CLOCK = <code class="code">sig</code> <a href="V1.CLOCK.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Clockoperations">Clock operations</h1>
<p>

Currently read-only to retrieve the time in various formats.<br>
Currently read-only to retrieve the time in various formats.<br>
</div>
<hr width="100%">

<pre><code><span id="TYPEtm"><span class="keyword">type</span> <code class="type"></code>tm</span> = {</code></pre><table class="typetable">
<tr>
Expand Down
8 changes: 4 additions & 4 deletions V1.CONSOLE.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Console input/output" rel="Section" href="#1_Consoleinputoutput">
<title>V1.CONSOLE</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.CONSOLE</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.FLOW.html" title="V1.FLOW">Previous</a>
Expand All @@ -24,9 +23,10 @@
</div>
<h1>Module type <a href="type_V1.CONSOLE.html">V1.CONSOLE</a></h1>

<pre><span class="keyword">module type</span> CONSOLE = <code class="code">sig</code> <a href="V1.CONSOLE.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> CONSOLE = <code class="code">sig</code> <a href="V1.CONSOLE.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Consoleinputoutput">Console input/output</h1><br>
</div>
<hr width="100%">

<pre><span id="TYPEerror"><span class="keyword">type</span> <code class="type"></code>error</span> = <code class="type">[ `Invalid_console of string ]</code> </pre>
<div class="info ">
Expand Down
3 changes: 2 additions & 1 deletion V1.DEVICE.html
Expand Up @@ -25,7 +25,8 @@ <h1>Module type <a href="type_V1.DEVICE.html">V1.DEVICE</a></h1>
<h1 id="1_Abtractdevices">Abtract devices</h1>
<p>

Defines the functions to connect and disconnect any device<br>
Defines the functions to define what is a device state and
how to disconnect such a device.<br>
</div>
<hr width="100%">

Expand Down
8 changes: 4 additions & 4 deletions V1.ENTROPY.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Native entropy provider" rel="Section" href="#1_Nativeentropyprovider">
<title>V1.ENTROPY</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.ENTROPY</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.RANDOM.html" title="V1.RANDOM">Previous</a>
Expand All @@ -24,9 +23,10 @@
</div>
<h1>Module type <a href="type_V1.ENTROPY.html">V1.ENTROPY</a></h1>

<pre><span class="keyword">module type</span> ENTROPY = <code class="code">sig</code> <a href="V1.ENTROPY.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> ENTROPY = <code class="code">sig</code> <a href="V1.ENTROPY.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Nativeentropyprovider">Native entropy provider</h1> *<br>
</div>
<hr width="100%">

<pre><span id="TYPEerror"><span class="keyword">type</span> <code class="type"></code>error</span> = <code class="type">[ `No_entropy_device of string ]</code> </pre>
<div class="info ">
Expand Down
12 changes: 6 additions & 6 deletions V1.ETHIF.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Ethernet stack" rel="Section" href="#1_Ethernetstack">
<title>V1.ETHIF</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.ETHIF</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.NETWORK.html" title="V1.NETWORK">Previous</a>
Expand All @@ -24,13 +23,14 @@
</div>
<h1>Module type <a href="type_V1.ETHIF.html">V1.ETHIF</a></h1>

<pre><span class="keyword">module type</span> ETHIF = <code class="code">sig</code> <a href="V1.ETHIF.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> ETHIF = <code class="code">sig</code> <a href="V1.ETHIF.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Ethernetstack">Ethernet stack</h1>
<p>

An Ethernet stack that parses frames from a network device and
can associate them with IP address via ARP.<br>
An Ethernet stack that parses frames from a network device and
can associate them with IP address via ARP.<br>
</div>
<hr width="100%">

<pre><span id="TYPEbuffer"><span class="keyword">type</span> <code class="type"></code>buffer</span> </pre>
<div class="info ">
Expand Down
8 changes: 4 additions & 4 deletions V1.FLOW.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Connection between endpoints" rel="Section" href="#1_Connectionbetweenendpoints">
<title>V1.FLOW</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.FLOW</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.CLOCK.html" title="V1.CLOCK">Previous</a>
Expand All @@ -24,9 +23,10 @@
</div>
<h1>Module type <a href="type_V1.FLOW.html">V1.FLOW</a></h1>

<pre><span class="keyword">module type</span> FLOW = <code class="code">sig</code> <a href="V1.FLOW.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> FLOW = <code class="code">sig</code> <a href="V1.FLOW.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Connectionbetweenendpoints">Connection between endpoints</h1><br>
</div>
<hr width="100%">

<pre><span id="TYPEio"><span class="keyword">type</span> <code class="type">+'a</code> io</span> </pre>
<div class="info ">
Expand Down
8 changes: 4 additions & 4 deletions V1.FS.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Filesystem" rel="Section" href="#1_Filesystem">
<title>V1.FS</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.FS</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.CHANNEL.html" title="V1.CHANNEL">Previous</a>
Expand All @@ -24,9 +23,10 @@
</div>
<h1>Module type <a href="type_V1.FS.html">V1.FS</a></h1>

<pre><span class="keyword">module type</span> FS = <code class="code">sig</code> <a href="V1.FS.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> FS = <code class="code">sig</code> <a href="V1.FS.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Filesystem">Filesystem</h1><br>
</div>
<hr width="100%">

<pre><span id="TYPEblock_device_error"><span class="keyword">type</span> <code class="type"></code>block_device_error</span> </pre>
<div class="info ">
Expand Down
10 changes: 5 additions & 5 deletions V1.IP.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="IP stack" rel="Section" href="#1_IPstack">
<title>V1.IP</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.IP</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.ETHIF.html" title="V1.ETHIF">Previous</a>
Expand All @@ -24,12 +23,13 @@
</div>
<h1>Module type <a href="type_V1.IP.html">V1.IP</a></h1>

<pre><span class="keyword">module type</span> IP = <code class="code">sig</code> <a href="V1.IP.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> IP = <code class="code">sig</code> <a href="V1.IP.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_IPstack">IP stack</h1>
<p>

An IP stack that parses Ethernet frames into IP packets<br>
An IP stack that parses Ethernet frames into IP packets<br>
</div>
<hr width="100%">

<pre><span id="TYPEbuffer"><span class="keyword">type</span> <code class="type"></code>buffer</span> </pre>
<div class="info ">
Expand Down
8 changes: 4 additions & 4 deletions V1.IPV4.html
Expand Up @@ -23,12 +23,12 @@
</div>
<h1>Module type <a href="type_V1.IPV4.html">V1.IPV4</a></h1>

<pre><span class="keyword">module type</span> IPV4 = <code class="code">sig</code> <a href="V1.IPV4.html">..</a> <code class="code">end</code></pre><hr width="100%">

<pre><span class="keyword">include</span> <a href="V1.IP.html">V1.IP</a></pre>
<div class="info ">
<pre><span class="keyword">module type</span> IPV4 = <code class="code">sig</code> <a href="V1.IPV4.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_IPv4stack">IPv4 stack</h1><br>
</div>
<hr width="100%">

<pre><span class="keyword">include</span> <a href="V1.IP.html">V1.IP</a></pre>

<pre><span id="VALinput_arpv4"><span class="keyword">val</span> input_arpv4</span> : <code class="type">t -> buffer -> unit io</code></pre><div class="info ">
<b>FIXME</b><br>
Expand Down
8 changes: 4 additions & 4 deletions V1.IPV6.html
Expand Up @@ -23,10 +23,10 @@
</div>
<h1>Module type <a href="type_V1.IPV6.html">V1.IPV6</a></h1>

<pre><span class="keyword">module type</span> IPV6 = <code class="code">sig</code> <a href="V1.IPV6.html">..</a> <code class="code">end</code></pre><hr width="100%">

<pre><span class="keyword">include</span> <a href="V1.IP.html">V1.IP</a></pre>
<div class="info ">
<pre><span class="keyword">module type</span> IPV6 = <code class="code">sig</code> <a href="V1.IPV6.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_IPv6stack">IPv6 stack</h1><br>
</div>
<hr width="100%">

<pre><span class="keyword">include</span> <a href="V1.IP.html">V1.IP</a></pre>
</body></html>
8 changes: 4 additions & 4 deletions V1.KV_RO.html
Expand Up @@ -13,18 +13,18 @@
<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"><link title="Static Key/value store" rel="Section" href="#1_StaticKeyvaluestore">
<title>V1.KV_RO</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.KV_RO</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.FS.html" title="V1.FS">Previous</a>
&nbsp;<a class="up" href="V1.html" title="V1">Up</a>
&nbsp;</div>
<h1>Module type <a href="type_V1.KV_RO.html">V1.KV_RO</a></h1>

<pre><span class="keyword">module type</span> KV_RO = <code class="code">sig</code> <a href="V1.KV_RO.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> KV_RO = <code class="code">sig</code> <a href="V1.KV_RO.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_StaticKeyvaluestore">Static Key/value store</h1><br>
</div>
<hr width="100%">

<pre><code><span id="TYPEerror"><span class="keyword">type</span> <code class="type"></code>error</span> = </code></pre><table class="typetable">
<tr>
Expand Down
10 changes: 5 additions & 5 deletions V1.NETWORK.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Network stack" rel="Section" href="#1_Networkstack">
<title>V1.NETWORK</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.NETWORK</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.BLOCK.html" title="V1.BLOCK">Previous</a>
Expand All @@ -24,12 +23,13 @@
</div>
<h1>Module type <a href="type_V1.NETWORK.html">V1.NETWORK</a></h1>

<pre><span class="keyword">module type</span> NETWORK = <code class="code">sig</code> <a href="V1.NETWORK.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> NETWORK = <code class="code">sig</code> <a href="V1.NETWORK.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Networkstack">Network stack</h1>
<p>

A network interface that serves Ethernet frames.<br>
A network interface that serves Ethernet frames.<br>
</div>
<hr width="100%">

<pre><span id="TYPEpage_aligned_buffer"><span class="keyword">type</span> <code class="type"></code>page_aligned_buffer</span> </pre>
<div class="info ">
Expand Down
14 changes: 7 additions & 7 deletions V1.RANDOM.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="Random" rel="Section" href="#1_Random">
<title>V1.RANDOM</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.RANDOM</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.TIME.html" title="V1.TIME">Previous</a>
Expand All @@ -24,14 +23,15 @@
</div>
<h1>Module type <a href="type_V1.RANDOM.html">V1.RANDOM</a></h1>

<pre><span class="keyword">module type</span> RANDOM = <code class="code">sig</code> <a href="V1.RANDOM.html">..</a> <code class="code">end</code></pre><hr width="100%">
<br>
<pre><span class="keyword">module type</span> RANDOM = <code class="code">sig</code> <a href="V1.RANDOM.html">..</a> <code class="code">end</code></pre><div class="info modtype top">
<h1 id="1_Random">Random</h1>
<p>

Operations to generate entropy. This is currently a passthrough
to the OCaml Random generator, and will be deprecated in V2 and
turned into a proper DEVICE with blocking modes.<br>
Operations to generate entropy. This is currently a passthrough
to the OCaml Random generator, and will be deprecated in V2 and
turned into a proper DEVICE with blocking modes.<br>
</div>
<hr width="100%">

<pre><span id="VALself_init"><span class="keyword">val</span> self_init</span> : <code class="type">unit -> unit</code></pre><div class="info ">
Initialize the generator with a random seed chosen in a
Expand Down
3 changes: 0 additions & 3 deletions V1.STACKV4.IPV4.html
Expand Up @@ -28,9 +28,6 @@ <h1>Module <a href="type_V1.STACKV4.IPV4.html">V1.STACKV4.IPV4</a></h1>
and type t = ipv4</code></pre><hr width="100%">

<pre><span class="keyword">include</span> <a href="V1.IP.html">V1.IP</a></pre>
<div class="info ">
<h1 id="1_IPv4stack">IPv4 stack</h1><br>
</div>

<pre><span id="VALinput_arpv4"><span class="keyword">val</span> input_arpv4</span> : <code class="type">t -> buffer -> unit io</code></pre><div class="info ">
<b>FIXME</b><br>
Expand Down
9 changes: 1 addition & 8 deletions V1.STACKV4.TCPV4.html
Expand Up @@ -14,8 +14,7 @@
<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"><link title="TCP stack" rel="Section" href="#1_TCPstack">
<title>V1.STACKV4.TCPV4</title>
<link title="V1_LWT" rel="Chapter" href="V1_LWT.html"><title>V1.STACKV4.TCPV4</title>
</head>
<body>
<div class="navbar"><a class="pre" href="V1.STACKV4.UDPV4.html" title="V1.STACKV4.UDPV4">Previous</a>
Expand All @@ -30,12 +29,6 @@ <h1>Module <a href="type_V1.STACKV4.TCPV4.html">V1.STACKV4.TCPV4</a></h1>
and type buffer = buffer
and type t = tcpv4
and type ip = ipv4</code></pre><hr width="100%">
<br>
<h1 id="1_TCPstack">TCP stack</h1>
<p>

A TCP stack that can send and receive reliable streams using the
TCP protocol.<br>

<pre><span id="TYPEbuffer"><span class="keyword">type</span> <code class="type"></code>buffer</span> </pre>
<div class="info ">
Expand Down

0 comments on commit d6784bf

Please sign in to comment.