Skip to content

Commit

Permalink
Update tar doc to 3.1.2.
Browse files Browse the repository at this point in the history
  • Loading branch information
@reynir
reynir committed Sep 20, 2024
1 parent d5cbc50 commit 4dbf439
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="tar/index.html">tar</a> <span class="version">v3.1.1</span></li>
<li><a href="tar-eio/index.html">tar-eio</a> <span class="version">v3.1.1</span></li>
<li><a href="tar-mirage/index.html">tar-mirage</a> <span class="version">v3.1.1</span></li>
<li><a href="tar-unix/index.html">tar-unix</a> <span class="version">v3.1.1</span></li>
<li><a href="tar/index.html">tar</a> <span class="version">v3.1.2</span></li>
<li><a href="tar-eio/index.html">tar-eio</a> <span class="version">v3.1.2</span></li>
<li><a href="tar-mirage/index.html">tar-mirage</a> <span class="version">v3.1.2</span></li>
<li><a href="tar-unix/index.html">tar-unix</a> <span class="version">v3.1.2</span></li>
</ol>
</div>
</main>
Expand Down
2 changes: 1 addition & 1 deletion tar/Tar/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Tar (tar.Tar)</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">tar</a> &#x00BB; Tar</nav><header class="odoc-preamble"><h1>Module <code><span>Tar</span></code></h1><p>Tar utilities</p><p><em>v3.1.1 - <a href="https://github.com/mirage/ocaml-tar">homepage</a></em></p></header><nav class="odoc-toc"><ul><li><a href="#decoding-and-encoding-of-a-whole-archive">Decoding and encoding of a whole archive</a></li><li><a href="#pure-implementation-of-fold.">Pure implementation of <code>fold</code>.</a></li></ul></nav><div class="odoc-content"><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.Checksum_mismatch" class="def variant constructor anchored"><a href="#type-error.Checksum_mismatch" class="anchor"></a><code><span>| </span><span>`Checksum_mismatch</span></code></li><li id="type-error.Corrupt_pax_header" class="def variant constructor anchored"><a href="#type-error.Corrupt_pax_header" class="anchor"></a><code><span>| </span><span>`Corrupt_pax_header</span></code></li><li id="type-error.Zero_block" class="def variant constructor anchored"><a href="#type-error.Zero_block" class="anchor"></a><code><span>| </span><span>`Zero_block</span></code></li><li id="type-error.Unmarshal" class="def variant constructor anchored"><a href="#type-error.Unmarshal" class="anchor"></a><code><span>| </span><span>`Unmarshal <span class="keyword">of</span> string</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of errors that may occur.</p></div></div><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><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><span>[&lt; <a href="#type-error">error</a> ]</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_error ppf e</code> pretty prints the error <code>e</code> on the formatter <code>ppf</code>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Header"><a href="#module-Header" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Header/index.html">Header</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Process and create tar file headers.</p></div></div><h2 id="decoding-and-encoding-of-a-whole-archive"><a href="#decoding-and-encoding-of-a-whole-archive" class="anchor"></a>Decoding and encoding of a whole archive</h2><div class="odoc-spec"><div class="spec type anchored" id="type-decode_state"><a href="#type-decode_state" class="anchor"></a><code><span><span class="keyword">type</span> decode_state</span></code></div><div class="spec-doc"><p>The type of the decode state.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_state"><a href="#val-decode_state" class="anchor"></a><code><span><span class="keyword">val</span> decode_state : <span><span class="optlabel">?global</span>:<a href="Header/Extended/index.html#type-t">Header.Extended.t</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-decode_state">decode_state</a></span></code></div><div class="spec-doc"><p><code>decode_state ~global ()</code> constructs a decode_state.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode"><a href="#val-decode" class="anchor"></a><code><span><span class="keyword">val</span> decode :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Tar (tar.Tar)</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">tar</a> &#x00BB; Tar</nav><header class="odoc-preamble"><h1>Module <code><span>Tar</span></code></h1><p>Tar utilities</p><p><em>v3.1.2 - <a href="https://github.com/mirage/ocaml-tar">homepage</a></em></p></header><nav class="odoc-toc"><ul><li><a href="#decoding-and-encoding-of-a-whole-archive">Decoding and encoding of a whole archive</a></li><li><a href="#pure-implementation-of-fold.">Pure implementation of <code>fold</code>.</a></li></ul></nav><div class="odoc-content"><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.Checksum_mismatch" class="def variant constructor anchored"><a href="#type-error.Checksum_mismatch" class="anchor"></a><code><span>| </span><span>`Checksum_mismatch</span></code></li><li id="type-error.Corrupt_pax_header" class="def variant constructor anchored"><a href="#type-error.Corrupt_pax_header" class="anchor"></a><code><span>| </span><span>`Corrupt_pax_header</span></code></li><li id="type-error.Zero_block" class="def variant constructor anchored"><a href="#type-error.Zero_block" class="anchor"></a><code><span>| </span><span>`Zero_block</span></code></li><li id="type-error.Unmarshal" class="def variant constructor anchored"><a href="#type-error.Unmarshal" class="anchor"></a><code><span>| </span><span>`Unmarshal <span class="keyword">of</span> string</span></code></li></ol><code><span> ]</span></code></div><div class="spec-doc"><p>The type of errors that may occur.</p></div></div><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><span class="xref-unresolved">Stdlib</span>.Format.formatter <span class="arrow">&#45;&gt;</span></span> <span><span>[&lt; <a href="#type-error">error</a> ]</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_error ppf e</code> pretty prints the error <code>e</code> on the formatter <code>ppf</code>.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Header"><a href="#module-Header" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Header/index.html">Header</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Process and create tar file headers.</p></div></div><h2 id="decoding-and-encoding-of-a-whole-archive"><a href="#decoding-and-encoding-of-a-whole-archive" class="anchor"></a>Decoding and encoding of a whole archive</h2><div class="odoc-spec"><div class="spec type anchored" id="type-decode_state"><a href="#type-decode_state" class="anchor"></a><code><span><span class="keyword">type</span> decode_state</span></code></div><div class="spec-doc"><p>The type of the decode state.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode_state"><a href="#val-decode_state" class="anchor"></a><code><span><span class="keyword">val</span> decode_state : <span><span class="optlabel">?global</span>:<a href="Header/Extended/index.html#type-t">Header.Extended.t</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <span class="arrow">&#45;&gt;</span></span> <a href="#type-decode_state">decode_state</a></span></code></div><div class="spec-doc"><p><code>decode_state ~global ()</code> constructs a decode_state.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode"><a href="#val-decode" class="anchor"></a><code><span><span class="keyword">val</span> decode :
<span><a href="#type-decode_state">decode_state</a> <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="#type-decode_state">decode_state</a>
Expand Down

0 comments on commit 4dbf439

Please sign in to comment.