Update awa doc to 0.4.0.

mirage · Aug 28, 2024 · 1b57a49 · 1b57a49
1 parent adfe85a
commit 1b57a49
Show file tree

Hide file tree

Showing 25 changed files with 45 additions and 54 deletions.
diff --git a/api/awa-mirage/Awa_mirage/Make/index.html b/api/awa-mirage/Awa_mirage/Make/index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (awa-mirage.Awa_mirage.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">awa-mirage</a> &#x00BB; <a href="../index.html">Awa_mirage</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Awa_mirage.Make</span></code></h1><p>SSH module given a flow</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-F"><a href="#argument-1-F" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>F</span><span> : <span class="xref-unresolved">Mirage_flow</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-2-T"><a href="#argument-2-T" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>T</span><span> : <span class="xref-unresolved">Mirage_time</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-3-M"><a href="#argument-3-M" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>M</span><span> : <span class="xref-unresolved">Mirage_clock</span>.MCLOCK</span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec type anchored" id="type-error"><a href="#type-error" class="anchor"></a><code><span><span class="keyword">type</span> error</span><span> = </span><span>[ </span></code><ol><li id="type-error.Msg" class="def variant constructor anchored"><a href="#type-error.Msg" class="anchor"></a><code><span>| </span><span>`Msg <span class="keyword">of</span> string</span></code></li><li id="type-error.Read" class="def variant constructor anchored"><a href="#type-error.Read" class="anchor"></a><code><span>| </span><span>`Read <span class="keyword">of</span> <span class="xref-unresolved">F</span>.error</span></code></li><li id="type-error.Write" class="def variant constructor anchored"><a href="#type-error.Write" class="anchor"></a><code><span>| </span><span>`Write <span class="keyword">of</span> <span class="xref-unresolved">F</span>.write_error</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>possible errors: incoming alert, processing failure, or a problem in the underlying flow.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-write_error"><a href="#type-write_error" class="anchor"></a><code><span><span class="keyword">type</span> write_error</span><span> = </span><span>[ </span></code><ol><li id="type-write_error.Closed" class="def variant constructor anchored"><a href="#type-write_error.Closed" class="anchor"></a><code><span>| </span><span>`Closed</span></code></li><li id="type-write_error.error" class="def variant type anchored"><a href="#type-write_error.error" class="anchor"></a><code><span>| </span><span><a href="#type-error">error</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type for write errors.</p></div></div><div class="odoc-include"><div class="spec-doc"><p>we provide the FLOW interface</p></div><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="xref-unresolved">Mirage_flow</span>.S
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (awa-mirage.Awa_mirage.Make)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">awa-mirage</a> &#x00BB; <a href="../index.html">Awa_mirage</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Awa_mirage.Make</span></code></h1><p>SSH module given a flow</p></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-F"><a href="#argument-1-F" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>F</span><span> : <span class="xref-unresolved">Mirage_flow</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-2-T"><a href="#argument-2-T" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>T</span><span> : <span class="xref-unresolved">Mirage_time</span>.S</span></code></div></div><div class="odoc-spec"><div class="spec parameter anchored" id="argument-3-M"><a href="#argument-3-M" class="anchor"></a><code><span><span class="keyword">module</span> </span><span>M</span><span> : <span class="xref-unresolved">Mirage_clock</span>.MCLOCK</span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><div class="odoc-spec"><div class="spec type anchored" id="type-error"><a href="#type-error" class="anchor"></a><code><span><span class="keyword">type</span> error</span><span> = </span><span>[ </span></code><ol><li id="type-error.Msg" class="def variant constructor anchored"><a href="#type-error.Msg" class="anchor"></a><code><span>| </span><span>`Msg <span class="keyword">of</span> string</span></code></li><li id="type-error.Read" class="def variant constructor anchored"><a href="#type-error.Read" class="anchor"></a><code><span>| </span><span>`Read <span class="keyword">of</span> <span class="xref-unresolved">F</span>.error</span></code></li><li id="type-error.Write" class="def variant constructor anchored"><a href="#type-error.Write" class="anchor"></a><code><span>| </span><span>`Write <span class="keyword">of</span> <span class="xref-unresolved">F</span>.write_error</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>possible errors: incoming alert, processing failure, or a problem in the underlying flow.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-write_error"><a href="#type-write_error" class="anchor"></a><code><span><span class="keyword">type</span> write_error</span><span> = </span><span>[ </span></code><ol><li id="type-write_error.Closed" class="def variant constructor anchored"><a href="#type-write_error.Closed" class="anchor"></a><code><span>| </span><span>`Closed</span></code></li><li id="type-write_error.error" class="def variant type anchored"><a href="#type-write_error.error" class="anchor"></a><code><span>| </span><span><a href="#type-error">error</a></span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type for write errors.</p></div></div><div class="odoc-include"><div class="spec-doc"><p>we provide the FLOW interface</p></div><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <span class="xref-unresolved">Mirage_flow</span>.S
   <span class="keyword">with</span> <span><span class="keyword">type</span> <span class="xref-unresolved">error</span> := <span class="xref-unresolved">error</span></span>
-   <span class="keyword">and</span> <span><span class="keyword">type</span> <span class="xref-unresolved">write_error</span> := <span class="xref-unresolved">write_error</span></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-pp_error"><a href="#val-pp_error" class="anchor"></a><code><span><span class="keyword">val</span> pp_error : <span><a href="#type-error">error</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_write_error"><a href="#val-pp_write_error" class="anchor"></a><code><span><span class="keyword">val</span> pp_write_error : <span><a href="#type-write_error">write_error</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-flow"><a href="#type-flow" class="anchor"></a><code><span><span class="keyword">type</span> flow</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-read"><a href="#val-read" class="anchor"></a><code><span><span class="keyword">val</span> read : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<span><span class="xref-unresolved">Cstruct</span>.t <span class="xref-unresolved">Mirage_flow</span>.or_eof</span>, <a href="#type-error">error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write"><a href="#val-write" class="anchor"></a><code><span><span class="keyword">val</span> write : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span><span>(unit, <a href="#type-write_error">write_error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-writev"><a href="#val-writev" class="anchor"></a><code><span><span class="keyword">val</span> writev : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Cstruct</span>.t list</span> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(unit, <a href="#type-write_error">write_error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-client_of_flow"><a href="#val-client_of_flow" class="anchor"></a><code><span><span class="keyword">val</span> client_of_flow : 
+   <span class="keyword">and</span> <span><span class="keyword">type</span> <span class="xref-unresolved">write_error</span> := <span class="xref-unresolved">write_error</span></span></span></code></summary><div class="odoc-spec"><div class="spec value anchored" id="val-pp_error"><a href="#val-pp_error" class="anchor"></a><code><span><span class="keyword">val</span> pp_error : <span><a href="#type-error">error</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-pp_write_error"><a href="#val-pp_write_error" class="anchor"></a><code><span><span class="keyword">val</span> pp_write_error : <span><a href="#type-write_error">write_error</a> <span class="xref-unresolved">Fmt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-flow"><a href="#type-flow" class="anchor"></a><code><span><span class="keyword">type</span> flow</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-read"><a href="#val-read" class="anchor"></a><code><span><span class="keyword">val</span> read : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(<span><span class="xref-unresolved">Cstruct</span>.t <span class="xref-unresolved">Mirage_flow</span>.or_eof</span>, <a href="#type-error">error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write"><a href="#val-write" class="anchor"></a><code><span><span class="keyword">val</span> write : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">&#45;&gt;</span></span> <span><span><span>(unit, <a href="#type-write_error">write_error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-writev"><a href="#val-writev" class="anchor"></a><code><span><span class="keyword">val</span> writev : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span><span class="xref-unresolved">Cstruct</span>.t list</span> <span class="arrow">&#45;&gt;</span></span> <span><span><span>(unit, <a href="#type-write_error">write_error</a>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-shutdown"><a href="#val-shutdown" class="anchor"></a><code><span><span class="keyword">val</span> shutdown : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span><span>[ `read <span>| `read_write</span> <span>| `write</span> ]</span> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-close"><a href="#val-close" class="anchor"></a><code><span><span class="keyword">val</span> close : <span><a href="#type-flow">flow</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-client_of_flow"><a href="#val-client_of_flow" class="anchor"></a><code><span><span class="keyword">val</span> client_of_flow : 
   <span><span class="optlabel">?authenticator</span>:<a href="../../../awa/Awa/Keys/index.html#type-authenticator">Awa.Keys.authenticator</a> <span class="arrow">&#45;&gt;</span></span>
   <span><span class="label">user</span>:string <span class="arrow">&#45;&gt;</span></span>
   <span><span>[ <span>`Pubkey of <a href="../../../awa/Awa/Hostkey/index.html#type-priv">Awa.Hostkey.priv</a></span> <span><span>| `Password</span> of string</span> ]</span> <span class="arrow">&#45;&gt;</span></span>

diff --git a/api/awa-mirage/Awa_mirage/index.html b/api/awa-mirage/Awa_mirage/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Awa_mirage (awa-mirage.Awa_mirage)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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">awa-mirage</a> &#x00BB; Awa_mirage</nav><header class="odoc-preamble"><h1>Module <code><span>Awa_mirage</span></code></h1><p>Effectful operations using Mirage for pure SSH.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Awa_mirage (awa-mirage.Awa_mirage)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">awa-mirage</a> &#x00BB; Awa_mirage</nav><header class="odoc-preamble"><h1>Module <code><span>Awa_mirage</span></code></h1><p>Effectful operations using Mirage for pure SSH.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Make"><a href="#module-Make" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Make/index.html">Make</a></span><span>
   (<a href="Make/index.html#argument-1-F">F</a> : <span class="xref-unresolved">Mirage_flow</span>.S)
   (<a href="Make/index.html#argument-2-T">T</a> : <span class="xref-unresolved">Mirage_time</span>.S)
   (<a href="Make/index.html#argument-3-M">M</a> : <span class="xref-unresolved">Mirage_clock</span>.MCLOCK) : 

diff --git a/api/awa-mirage/index.html b/api/awa-mirage/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (awa-mirage.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.1"/><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> – awa-mirage</nav><header class="odoc-preamble"><h1 id="awa-mirage-index"><a href="#awa-mirage-index" class="anchor"></a>awa-mirage index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-awa-mirage">Library awa-mirage</a></li></ul></nav><div class="odoc-content"><h2 id="library-awa-mirage"><a href="#library-awa-mirage" class="anchor"></a>Library awa-mirage</h2><p>The entry point of this library is the module: <a href="Awa_mirage/index.html"><code>Awa_mirage</code></a>.</p></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (awa-mirage.index)</title><meta charset="utf-8"/><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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> – awa-mirage</nav><header class="odoc-preamble"><h1 id="awa-mirage-index"><a href="#awa-mirage-index" class="anchor"></a>awa-mirage index</h1></header><nav class="odoc-toc"><ul><li><a href="#library-awa-mirage">Library awa-mirage</a></li></ul></nav><div class="odoc-content"><h2 id="library-awa-mirage"><a href="#library-awa-mirage" class="anchor"></a>Library awa-mirage</h2><p>The entry point of this library is the module: <a href="Awa_mirage/index.html"><code>Awa_mirage</code></a>.</p></div></body></html>