Update tls doc to 0.17.3.

mirleft · Nov 20, 2023 · bbd47dd · bbd47dd
1 parent 4ef1f90
commit bbd47dd
Show file tree

Hide file tree

Showing 83 changed files with 74 additions and 62 deletions.
diff --git a/doc/index.html b/doc/index.html
@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
     <title>index</title>
-    <link rel="stylesheet" href="./_odoc_support/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>
@@ -11,10 +11,10 @@
       <div class="by-name">
       <h2>OCaml package documentation</h2>
       <ol>
-      <li><a href="tls/index.html">tls</a> <span class="version">0.17.1</span></li>
-      <li><a href="tls-async/index.html">tls-async</a> <span class="version">0.17.1</span></li>
-      <li><a href="tls-lwt/index.html">tls-lwt</a> <span class="version">0.17.1</span></li>
-      <li><a href="tls-mirage/index.html">tls-mirage</a> <span class="version">0.17.1</span></li>
+      <li><a href="tls/index.html">tls</a> <span class="version">0.17.3</span></li>
+      <li><a href="tls-async/index.html">tls-async</a> <span class="version">0.17.3</span></li>
+      <li><a href="tls-lwt/index.html">tls-lwt</a> <span class="version">0.17.3</span></li>
+      <li><a href="tls-mirage/index.html">tls-mirage</a> <span class="version">0.17.3</span></li>
       </ol>
       </div>
     </main>

diff --git a/...doc_support/fonts/KaTeX_AMS-Regular.woff2 → ...doc.support/fonts/KaTeX_AMS-Regular.woff2 b/...doc_support/fonts/KaTeX_AMS-Regular.woff2 → ...doc.support/fonts/KaTeX_AMS-Regular.woff2
diff --git a/...upport/fonts/KaTeX_Caligraphic-Bold.woff2 → ...upport/fonts/KaTeX_Caligraphic-Bold.woff2 b/...upport/fonts/KaTeX_Caligraphic-Bold.woff2 → ...upport/fonts/KaTeX_Caligraphic-Bold.woff2
diff --git a/...ort/fonts/KaTeX_Caligraphic-Regular.woff2 → ...ort/fonts/KaTeX_Caligraphic-Regular.woff2 b/...ort/fonts/KaTeX_Caligraphic-Regular.woff2 → ...ort/fonts/KaTeX_Caligraphic-Regular.woff2
diff --git a/...oc_support/fonts/KaTeX_Fraktur-Bold.woff2 → ...oc.support/fonts/KaTeX_Fraktur-Bold.woff2 b/...oc_support/fonts/KaTeX_Fraktur-Bold.woff2 → ...oc.support/fonts/KaTeX_Fraktur-Bold.woff2
diff --git a/...support/fonts/KaTeX_Fraktur-Regular.woff2 → ...support/fonts/KaTeX_Fraktur-Regular.woff2 b/...support/fonts/KaTeX_Fraktur-Regular.woff2 → ...support/fonts/KaTeX_Fraktur-Regular.woff2
diff --git a/..._odoc_support/fonts/KaTeX_Main-Bold.woff2 → doc/odoc.support/fonts/KaTeX_Main-Bold.woff2 b/..._odoc_support/fonts/KaTeX_Main-Bold.woff2 → doc/odoc.support/fonts/KaTeX_Main-Bold.woff2
diff --git a/...support/fonts/KaTeX_Main-BoldItalic.woff2 → ...support/fonts/KaTeX_Main-BoldItalic.woff2 b/...support/fonts/KaTeX_Main-BoldItalic.woff2 → ...support/fonts/KaTeX_Main-BoldItalic.woff2
diff --git a/...doc_support/fonts/KaTeX_Main-Italic.woff2 → ...doc.support/fonts/KaTeX_Main-Italic.woff2 b/...doc_support/fonts/KaTeX_Main-Italic.woff2 → ...doc.support/fonts/KaTeX_Main-Italic.woff2
diff --git a/...oc_support/fonts/KaTeX_Main-Regular.woff2 → ...oc.support/fonts/KaTeX_Main-Regular.woff2 b/...oc_support/fonts/KaTeX_Main-Regular.woff2 → ...oc.support/fonts/KaTeX_Main-Regular.woff2
diff --git a/...support/fonts/KaTeX_Math-BoldItalic.woff2 → ...support/fonts/KaTeX_Math-BoldItalic.woff2 b/...support/fonts/KaTeX_Math-BoldItalic.woff2 → ...support/fonts/KaTeX_Math-BoldItalic.woff2
diff --git a/...doc_support/fonts/KaTeX_Math-Italic.woff2 → ...doc.support/fonts/KaTeX_Math-Italic.woff2 b/...doc_support/fonts/KaTeX_Math-Italic.woff2 → ...doc.support/fonts/KaTeX_Math-Italic.woff2
diff --git a/..._support/fonts/KaTeX_SansSerif-Bold.woff2 → ....support/fonts/KaTeX_SansSerif-Bold.woff2 b/..._support/fonts/KaTeX_SansSerif-Bold.woff2 → ....support/fonts/KaTeX_SansSerif-Bold.woff2
diff --git a/...upport/fonts/KaTeX_SansSerif-Italic.woff2 → ...upport/fonts/KaTeX_SansSerif-Italic.woff2 b/...upport/fonts/KaTeX_SansSerif-Italic.woff2 → ...upport/fonts/KaTeX_SansSerif-Italic.woff2
diff --git a/...pport/fonts/KaTeX_SansSerif-Regular.woff2 → ...pport/fonts/KaTeX_SansSerif-Regular.woff2 b/...pport/fonts/KaTeX_SansSerif-Regular.woff2 → ...pport/fonts/KaTeX_SansSerif-Regular.woff2
diff --git a/..._support/fonts/KaTeX_Script-Regular.woff2 → ....support/fonts/KaTeX_Script-Regular.woff2 b/..._support/fonts/KaTeX_Script-Regular.woff2 → ....support/fonts/KaTeX_Script-Regular.woff2
diff --git a/...c_support/fonts/KaTeX_Size1-Regular.woff2 → ...c.support/fonts/KaTeX_Size1-Regular.woff2 b/...c_support/fonts/KaTeX_Size1-Regular.woff2 → ...c.support/fonts/KaTeX_Size1-Regular.woff2
diff --git a/...c_support/fonts/KaTeX_Size2-Regular.woff2 → ...c.support/fonts/KaTeX_Size2-Regular.woff2 b/...c_support/fonts/KaTeX_Size2-Regular.woff2 → ...c.support/fonts/KaTeX_Size2-Regular.woff2
diff --git a/...c_support/fonts/KaTeX_Size3-Regular.woff2 → ...c.support/fonts/KaTeX_Size3-Regular.woff2 b/...c_support/fonts/KaTeX_Size3-Regular.woff2 → ...c.support/fonts/KaTeX_Size3-Regular.woff2
diff --git a/...c_support/fonts/KaTeX_Size4-Regular.woff2 → ...c.support/fonts/KaTeX_Size4-Regular.woff2 b/...c_support/fonts/KaTeX_Size4-Regular.woff2 → ...c.support/fonts/KaTeX_Size4-Regular.woff2
diff --git a/...port/fonts/KaTeX_Typewriter-Regular.woff2 → ...port/fonts/KaTeX_Typewriter-Regular.woff2 b/...port/fonts/KaTeX_Typewriter-Regular.woff2 → ...port/fonts/KaTeX_Typewriter-Regular.woff2
diff --git a/doc/_odoc_support/highlight.pack.js → doc/odoc.support/highlight.pack.js b/doc/_odoc_support/highlight.pack.js → doc/odoc.support/highlight.pack.js
diff --git a/doc/_odoc_support/katex.min.css → doc/odoc.support/katex.min.css b/doc/_odoc_support/katex.min.css → doc/odoc.support/katex.min.css
diff --git a/doc/_odoc_support/katex.min.js → doc/odoc.support/katex.min.js b/doc/_odoc_support/katex.min.js → doc/odoc.support/katex.min.js
diff --git a/doc/_odoc_support/odoc.css → doc/odoc.support/odoc.css b/doc/_odoc_support/odoc.css → doc/odoc.support/odoc.css
diff --git a/doc/tls-async/Tls_async/.dummy b/doc/tls-async/Tls_async/.dummy
diff --git a/doc/tls-async/Tls_async/Session/Fd/index.html b/doc/tls-async/Tls_async/Session/Fd/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Fd (tls-async.Tls_async.Session.Fd)</title><link rel="stylesheet" href="../../../../_odoc_support/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="../../../../_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">tls-async</a> &#x00BB; <a href="../../index.html">Tls_async</a> &#x00BB; <a href="../index.html">Session</a> &#x00BB; Fd</nav><header class="odoc-preamble"><h1>Module <code><span>Session.Fd</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span class="xref-unresolved">Async</span>.Reader.t * <span class="xref-unresolved">Async</span>.Writer.t</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-t">t</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>`Ok of int</span> <span>| `Eof</span> ]</span> <span class="xref-unresolved">Async</span>.Deferred.Or_error.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_full"><a href="#val-write_full" class="anchor"></a><code><span><span class="keyword">val</span> write_full : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Async</span>.Deferred.Or_error.t</span></span></code></div></div></div></body></html>
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Fd (tls-async.Tls_async.Session.Fd)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">tls-async</a> &#x00BB; <a href="../../index.html">Tls_async</a> &#x00BB; <a href="../index.html">Session</a> &#x00BB; Fd</nav><header class="odoc-preamble"><h1>Module <code><span>Session.Fd</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = <span class="xref-unresolved">Async</span>.Reader.t * <span class="xref-unresolved">Async</span>.Writer.t</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-t">t</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>`Ok of int</span> <span>| `Eof</span> ]</span> <span class="xref-unresolved">Async</span>.Deferred.Or_error.t</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-write_full"><a href="#val-write_full" class="anchor"></a><code><span><span class="keyword">val</span> write_full : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="xref-unresolved">Cstruct</span>.t <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="xref-unresolved">Async</span>.Deferred.Or_error.t</span></span></code></div></div></div></body></html>
diff --git a/doc/tls-async/Tls_async/Session/index.html b/doc/tls-async/Tls_async/Session/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Session (tls-async.Tls_async.Session)</title><link rel="stylesheet" href="../../../_odoc_support/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="../../../_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">tls-async</a> &#x00BB; <a href="../index.html">Tls_async</a> &#x00BB; Session</nav><header class="odoc-preamble"><h1>Module <code><span>Tls_async.Session</span></code></h1><p>Low-level API for working with TLS sessions. Most applications should use the high-level API below</p></header><nav class="odoc-toc"><ul><li><a href="#constructors">Constructors</a></li><li><a href="#common-stream-operations">Common stream operations</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Fd"><a href="#module-Fd" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Fd/index.html">Fd</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Abstract type of a session</p></div></div><h3 id="constructors"><a href="#constructors" class="anchor"></a>Constructors</h3><div class="odoc-spec"><div class="spec value anchored" id="val-server_of_fd"><a href="#val-server_of_fd" class="anchor"></a><code><span><span class="keyword">val</span> server_of_fd : <span><a href="../../../tls/Tls/Config/index.html#type-server">Tls.Config.server</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="Fd/index.html#type-t">Fd.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="xref-unresolved">Async</span>.Deferred.Or_error.t</span></span></code></div><div class="spec-doc"><p><code>server_of_fd server fd</code> is <code>t</code>, after server-side TLS handshake of <code>fd</code> using <code>server</code> configuration.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-client_of_fd"><a href="#val-client_of_fd" class="anchor"></a><code><span><span class="keyword">val</span> client_of_fd : 
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Session (tls-async.Tls_async.Session)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">tls-async</a> &#x00BB; <a href="../index.html">Tls_async</a> &#x00BB; Session</nav><header class="odoc-preamble"><h1>Module <code><span>Tls_async.Session</span></code></h1><p>Low-level API for working with TLS sessions. Most applications should use the high-level API below</p></header><nav class="odoc-toc"><ul><li><a href="#constructors">Constructors</a></li><li><a href="#common-stream-operations">Common stream operations</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Fd"><a href="#module-Fd" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Fd/index.html">Fd</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>Abstract type of a session</p></div></div><h3 id="constructors"><a href="#constructors" class="anchor"></a>Constructors</h3><div class="odoc-spec"><div class="spec value anchored" id="val-server_of_fd"><a href="#val-server_of_fd" class="anchor"></a><code><span><span class="keyword">val</span> server_of_fd : <span><a href="../../../tls/Tls/Config/index.html#type-server">Tls.Config.server</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="Fd/index.html#type-t">Fd.t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="xref-unresolved">Async</span>.Deferred.Or_error.t</span></span></code></div><div class="spec-doc"><p><code>server_of_fd server fd</code> is <code>t</code>, after server-side TLS handshake of <code>fd</code> using <code>server</code> configuration.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-client_of_fd"><a href="#val-client_of_fd" class="anchor"></a><code><span><span class="keyword">val</span> client_of_fd : 
   <span><a href="../../../tls/Tls/Config/index.html#type-client">Tls.Config.client</a> <span class="arrow">&#45;&gt;</span></span>
   <span>?host:<span><span>[ `host ]</span> <span class="xref-unresolved">Domain_name</span>.t</span> <span class="arrow">&#45;&gt;</span></span>
   <span><a href="Fd/index.html#type-t">Fd.t</a> <span class="arrow">&#45;&gt;</span></span>

diff --git a/doc/tls-async/Tls_async/X509_async/Authenticator/Param/index.html b/doc/tls-async/Tls_async/X509_async/Authenticator/Param/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Param (tls-async.Tls_async.X509_async.Authenticator.Param)</title><link rel="stylesheet" href="../../../../../_odoc_support/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="../../../../../_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">tls-async</a> &#x00BB; <a href="../../../index.html">Tls_async</a> &#x00BB; <a href="../../index.html">X509_async</a> &#x00BB; <a href="../index.html">Authenticator</a> &#x00BB; Param</nav><header class="odoc-preamble"><h1>Module <code><span>Authenticator.Param</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ca_file"><a href="#val-ca_file" class="anchor"></a><code><span><span class="keyword">val</span> ca_file : 
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Param (tls-async.Tls_async.X509_async.Authenticator.Param)</title><link rel="stylesheet" href="../../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">tls-async</a> &#x00BB; <a href="../../../index.html">Tls_async</a> &#x00BB; <a href="../../index.html">X509_async</a> &#x00BB; <a href="../index.html">Authenticator</a> &#x00BB; Param</nav><header class="odoc-preamble"><h1>Module <code><span>Authenticator.Param</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-ca_file"><a href="#val-ca_file" class="anchor"></a><code><span><span class="keyword">val</span> ca_file : 
   <span>?allowed_hashes:<span><span class="xref-unresolved">Mirage_crypto</span>.Hash.hash list</span> <span class="arrow">&#45;&gt;</span></span>
   <span>?crls:<span class="xref-unresolved">Core</span>.Filename.t <span class="arrow">&#45;&gt;</span></span>
   <span><span class="xref-unresolved">Core</span>.Filename.t <span class="arrow">&#45;&gt;</span></span>

diff --git a/doc/tls-async/Tls_async/X509_async/Authenticator/index.html b/doc/tls-async/Tls_async/X509_async/Authenticator/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Authenticator (tls-async.Tls_async.X509_async.Authenticator)</title><link rel="stylesheet" href="../../../../_odoc_support/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="../../../../_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">tls-async</a> &#x00BB; <a href="../../index.html">Tls_async</a> &#x00BB; <a href="../index.html">X509_async</a> &#x00BB; Authenticator</nav><header class="odoc-preamble"><h1>Module <code><span>X509_async.Authenticator</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> =
+<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Authenticator (tls-async.Tls_async.X509_async.Authenticator)</title><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.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">tls-async</a> &#x00BB; <a href="../../index.html">Tls_async</a> &#x00BB; <a href="../index.html">X509_async</a> &#x00BB; Authenticator</nav><header class="odoc-preamble"><h1>Module <code><span>X509_async.Authenticator</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> =
   <span>?ip:<span class="xref-unresolved">Ipaddr</span>.t <span class="arrow">&#45;&gt;</span></span>
   <span>host:<span><span><span>[ `host ]</span> <span class="xref-unresolved">Domain_name</span>.t</span> option</span> <span class="arrow">&#45;&gt;</span></span>
   <span><span><span class="xref-unresolved">X509</span>.Certificate.t list</span> <span class="arrow">&#45;&gt;</span></span>