Skip to content

Commit

Permalink
Update irmin doc to 3.9.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
art-w committed Oct 5, 2023
1 parent 980e379 commit b3c87af
Show file tree
Hide file tree
Showing 10,501 changed files with 26,353 additions and 17,744 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
37 changes: 19 additions & 18 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,25 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="irmin/index.html">irmin</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-bench/index.html">irmin-bench</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-chunk/index.html">irmin-chunk</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-cli/index.html">irmin-cli</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-containers/index.html">irmin-containers</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-fs/index.html">irmin-fs</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-git/index.html">irmin-git</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-graphql/index.html">irmin-graphql</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-http/index.html">irmin-http</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-mirage/index.html">irmin-mirage</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-mirage-git/index.html">irmin-mirage-git</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-mirage-graphql/index.html">irmin-mirage-graphql</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-pack/index.html">irmin-pack</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-pack-tools/index.html">irmin-pack-tools</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-test/index.html">irmin-test</a> <span class="version">3.8.0</span></li>
<li><a href="irmin-tezos/index.html">irmin-tezos</a> <span class="version">3.8.0</span></li>
<li><a href="libirmin/index.html">libirmin</a> <span class="version">3.8.0</span></li>
<li><a href="ppx_irmin/index.html">ppx_irmin</a> <span class="version">3.8.0</span></li>
<li><a href="irmin/index.html">irmin</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-bench/index.html">irmin-bench</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-chunk/index.html">irmin-chunk</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-cli/index.html">irmin-cli</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-client/index.html">irmin-client</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-containers/index.html">irmin-containers</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-fs/index.html">irmin-fs</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-git/index.html">irmin-git</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-graphql/index.html">irmin-graphql</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-mirage/index.html">irmin-mirage</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-mirage-git/index.html">irmin-mirage-git</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-mirage-graphql/index.html">irmin-mirage-graphql</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-pack/index.html">irmin-pack</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-pack-tools/index.html">irmin-pack-tools</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-server/index.html">irmin-server</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-test/index.html">irmin-test</a> <span class="version">3.9.0</span></li>
<li><a href="irmin-tezos/index.html">irmin-tezos</a> <span class="version">3.9.0</span></li>
<li><a href="libirmin/index.html">libirmin</a> <span class="version">3.9.0</span></li>
<li><a href="ppx_irmin/index.html">ppx_irmin</a> <span class="version">3.9.0</span></li>
</ol>
</div>
</main>
Expand Down
Empty file removed irmin-bench/Bench_common/.dummy
Empty file.
2 changes: 1 addition & 1 deletion irmin-bench/Bench_common/Conf/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Conf (irmin-bench.Bench_common.Conf)</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">irmin-bench</a> &#x00BB; <a href="../index.html">Bench_common</a> &#x00BB; Conf</nav><header class="odoc-preamble"><h1>Module <code><span>Bench_common.Conf</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-entries"><a href="#val-entries" class="anchor"></a><code><span><span class="keyword">val</span> entries : int</span></code></div><div class="spec-doc"><p>The branching factor of the inode tree. 32 is a good choice for general applications.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stable_hash"><a href="#val-stable_hash" class="anchor"></a><code><span><span class="keyword">val</span> stable_hash : int</span></code></div><div class="spec-doc"><p>This offers a way to conditional base hashing on node entries instead of inodes. It is available for some backwards compatibility applications, but for most applications, this should be set to 0.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-contents_length_header"><a href="#val-contents_length_header" class="anchor"></a><code><span><span class="keyword">val</span> contents_length_header : <a href="../../../irmin-pack/Irmin_pack/Conf/index.html#type-length_header">Irmin_pack.Conf.length_header</a></span></code></div><div class="spec-doc"><p>Describes the length header of the user's contents values when binary-encoded. Supported modes are:</p><ul><li><code>Some `Varint</code>: the length header is a LEB128-encoded integer at the very beginning of the encoded value.</li></ul><ul><li><code>None</code>: there is no length header, and values have unknown size. NOTE: when using <code>irmin-pack</code> in this mode, the selected indexing strategy <i>must</i> index all contents values (as recovering contents values from the store will require referring to the index for their length information).</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-inode_child_order"><a href="#val-inode_child_order" class="anchor"></a><code><span><span class="keyword">val</span> inode_child_order : <a href="../../../irmin-pack/Irmin_pack/Conf/index.html#type-inode_child_order">Irmin_pack.Conf.inode_child_order</a></span></code></div><div class="spec-doc"><p>The strategy used for sorting entries. <code>`Hash_bits</code> is the recommended choice. <code>`Seeded_hash</code> is vunerable to attacks if storing user-generated keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-forbid_empty_dir_persistence"><a href="#val-forbid_empty_dir_persistence" class="anchor"></a><code><span><span class="keyword">val</span> forbid_empty_dir_persistence : bool</span></code></div><div class="spec-doc"><p>If <code>true</code>, irmin-pack raises <code>Failure</code> if it is asked to save the empty inode. This default is <code>false</code>. It should be set to <code>true</code> if the <code>Schema</code> of the store allows a hash collision between the empty inode and this string of length 1: <code>&quot;\000&quot;</code>.</p><p>See https://github.com/mirage/irmin/issues/1304</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Conf (irmin-bench.Bench_common.Conf)</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">irmin-bench</a> &#x00BB; <a href="../index.html">Bench_common</a> &#x00BB; Conf</nav><header class="odoc-preamble"><h1>Module <code><span>Bench_common.Conf</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-entries"><a href="#val-entries" class="anchor"></a><code><span><span class="keyword">val</span> entries : int</span></code></div><div class="spec-doc"><p>The branching factor of the inode tree. 32 is a good choice for general applications.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-stable_hash"><a href="#val-stable_hash" class="anchor"></a><code><span><span class="keyword">val</span> stable_hash : int</span></code></div><div class="spec-doc"><p>This offers a way to conditional base hashing on node entries instead of inodes. It is available for some backwards compatibility applications, but for most applications, this should be set to 0.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-contents_length_header"><a href="#val-contents_length_header" class="anchor"></a><code><span><span class="keyword">val</span> contents_length_header : <a href="../../../irmin-pack/Irmin_pack/Conf/index.html#type-length_header">Irmin_pack.Conf.length_header</a></span></code></div><div class="spec-doc"><p>Describes the length header of the user's contents values when binary-encoded. Supported modes are:</p><ul><li><code>Some `Varint</code>: the length header is a LEB128-encoded integer at the very beginning of the encoded value.</li></ul><ul><li><code>None</code>: there is no length header, and values have unknown size. NOTE: when using <code>irmin-pack</code> in this mode, the selected indexing strategy <i>must</i> index all contents values (as recovering contents values from the store will require referring to the index for their length information).</li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-inode_child_order"><a href="#val-inode_child_order" class="anchor"></a><code><span><span class="keyword">val</span> inode_child_order : <a href="../../../irmin-pack/Irmin_pack/Conf/index.html#type-inode_child_order">Irmin_pack.Conf.inode_child_order</a></span></code></div><div class="spec-doc"><p>The strategy used for sorting entries. <code>`Hash_bits</code> is the recommended choice. <code>`Seeded_hash</code> is vunerable to attacks if storing user-generated keys.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-forbid_empty_dir_persistence"><a href="#val-forbid_empty_dir_persistence" class="anchor"></a><code><span><span class="keyword">val</span> forbid_empty_dir_persistence : bool</span></code></div><div class="spec-doc"><p>If <code>true</code>, irmin-pack raises <code>Failure</code> if it is asked to save the empty inode. This default is <code>false</code>. It should be set to <code>true</code> if the <code>Schema</code> of the store allows a hash collision between the empty inode and this string of length 1: <code>&quot;\000&quot;</code>.</p><p>See https://github.com/mirage/irmin/issues/1304</p></div></div></div></body></html>
2 changes: 1 addition & 1 deletion irmin-bench/Bench_common/FSHelper/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>FSHelper (irmin-bench.Bench_common.FSHelper)</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">irmin-bench</a> &#x00BB; <a href="../index.html">Bench_common</a> &#x00BB; FSHelper</nav><header class="odoc-preamble"><h1>Module <code><span>Bench_common.FSHelper</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-rm_dir"><a href="#val-rm_dir" class="anchor"></a><code><span><span class="keyword">val</span> rm_dir : <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_size"><a href="#val-get_size" class="anchor"></a><code><span><span class="keyword">val</span> get_size : <span>string <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>FSHelper (irmin-bench.Bench_common.FSHelper)</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">irmin-bench</a> &#x00BB; <a href="../index.html">Bench_common</a> &#x00BB; FSHelper</nav><header class="odoc-preamble"><h1>Module <code><span>Bench_common.FSHelper</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-rm_dir"><a href="#val-rm_dir" class="anchor"></a><code><span><span class="keyword">val</span> rm_dir : <span>string <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_size"><a href="#val-get_size" class="anchor"></a><code><span><span class="keyword">val</span> get_size : <span>string <span class="arrow">&#45;&gt;</span></span> int</span></code></div></div></div></body></html>
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Key (irmin-bench.Bench_common.Generate_trees.Store.Backend.Branch.Key)</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">irmin-bench</a> &#x00BB; <a href="../../../../../index.html">Bench_common</a> &#x00BB; <a href="../../../../index.html">Generate_trees</a> &#x00BB; <a href="../../../index.html">Store</a> &#x00BB; <a href="../../index.html">Backend</a> &#x00BB; <a href="../index.html">Branch</a> &#x00BB; Key</nav><header class="odoc-preamble"><h1>Module <code><span>Branch.Key</span></code></h1><p>Base functions on keys.</p></header><nav class="odoc-toc"><ul><li><a href="#signature-for-branches">Signature for Branches</a></li></ul></nav><div class="odoc-content"><h2 id="signature-for-branches"><a href="#signature-for-branches" class="anchor"></a>Signature for Branches</h2><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> = <a href="../index.html#type-key">key</a></span></code></div><div class="spec-doc"><p>The type for branches.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t"><a href="#val-t" class="anchor"></a><code><span><span class="keyword">val</span> t : <span><a href="#type-t">t</a> <a href="../../../../../../../irmin/Irmin/Type/index.html#type-t">Irmin.Type.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-main"><a href="#val-main" class="anchor"></a><code><span><span class="keyword">val</span> main : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>The name of the main branch.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_valid"><a href="#val-is_valid" class="anchor"></a><code><span><span class="keyword">val</span> is_valid : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Check if the branch is valid.</p></div></div></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Key (irmin-bench.Bench_common.Generate_trees.Store.Backend.Branch.Key)</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">irmin-bench</a> &#x00BB; <a href="../../../../../index.html">Bench_common</a> &#x00BB; <a href="../../../../index.html">Generate_trees</a> &#x00BB; <a href="../../../index.html">Store</a> &#x00BB; <a href="../../index.html">Backend</a> &#x00BB; <a href="../index.html">Branch</a> &#x00BB; Key</nav><header class="odoc-preamble"><h1>Module <code><span>Branch.Key</span></code></h1><p>Base functions on keys.</p></header><nav class="odoc-toc"><ul><li><a href="#signature-for-branches">Signature for Branches</a></li></ul></nav><div class="odoc-content"><h2 id="signature-for-branches"><a href="#signature-for-branches" class="anchor"></a>Signature for Branches</h2><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> = <a href="../index.html#type-key">key</a></span></code></div><div class="spec-doc"><p>The type for branches.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-t"><a href="#val-t" class="anchor"></a><code><span><span class="keyword">val</span> t : <span><a href="#type-t">t</a> <a href="../../../../../../../irmin/Irmin/Type/index.html#type-t">Irmin.Type.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-main"><a href="#val-main" class="anchor"></a><code><span><span class="keyword">val</span> main : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>The name of the main branch.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_valid"><a href="#val-is_valid" class="anchor"></a><code><span><span class="keyword">val</span> is_valid : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Check if the branch is valid.</p></div></div></div></body></html>
Loading

0 comments on commit b3c87af

Please sign in to comment.