-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
62 changed files
with
1,210 additions
and
321 deletions.
There are no files selected for viewing
Empty file.
26 changes: 13 additions & 13 deletions
26
doc/dockerfile/dockerfile-cmd/Dockerfile_cmd/Docker/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,19 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Docker (dockerfile-cmd.Dockerfile_cmd.Docker)</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">dockerfile-cmd</a> » <a href="../index.html">Dockerfile_cmd</a> » Docker</nav><header class="odoc-preamble"><h1>Module <code><span>Dockerfile_cmd.Docker</span></code></h1><p>Docker command invocation</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-bin"><a href="#val-bin" class="anchor"></a><code><span><span class="keyword">val</span> bin : <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exists"><a href="#val-exists" class="anchor"></a><code><span><span class="keyword">val</span> exists : <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-build_cmd"><a href="#val-build_cmd" class="anchor"></a><code><span><span class="keyword">val</span> build_cmd : | ||
| <span>?squash:bool <span class="arrow">-></span></span> | ||
| <span>?pull:bool <span class="arrow">-></span></span> | ||
| <span>?cache:bool <span class="arrow">-></span></span> | ||
| <span>?dockerfile:<span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> | ||
| <span>?tag:string <span class="arrow">-></span></span> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Docker (dockerfile-cmd.Dockerfile_cmd.Docker)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">dockerfile-cmd</a> » <a href="../index.html">Dockerfile_cmd</a> » Docker</nav><header class="odoc-preamble"><h1>Module <code><span>Dockerfile_cmd.Docker</span></code></h1><p>Docker command invocation</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-bin"><a href="#val-bin" class="anchor"></a><code><span><span class="keyword">val</span> bin : <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info"><a href="#val-info" class="anchor"></a><code><span><span class="keyword">val</span> info : <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exists"><a href="#val-exists" class="anchor"></a><code><span><span class="keyword">val</span> exists : <span>unit <span class="arrow">-></span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-build_cmd"><a href="#val-build_cmd" class="anchor"></a><code><span><span class="keyword">val</span> build_cmd : | ||
| <span><span class="optlabel">?squash</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?pull</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?cache</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?dockerfile</span>:<span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?tag</span>:string <span class="arrow">-></span></span> | ||
| <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> | ||
| <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-volume_cmd"><a href="#val-volume_cmd" class="anchor"></a><code><span><span class="keyword">val</span> volume_cmd : <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-push_cmd"><a href="#val-push_cmd" class="anchor"></a><code><span><span class="keyword">val</span> push_cmd : <span>string <span class="arrow">-></span></span> <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-build_id"><a href="#val-build_id" class="anchor"></a><code><span><span class="keyword">val</span> build_id : <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> <span><span>(string, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-run_cmd"><a href="#val-run_cmd" class="anchor"></a><code><span><span class="keyword">val</span> run_cmd : | ||
| <span>?mounts:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span> | ||
| <span>?volumes:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span> | ||
| <span>?rm:bool <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?mounts</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?volumes</span>:<span><span>(string * string)</span> list</span> <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?rm</span>:bool <span class="arrow">-></span></span> | ||
| <span>string <span class="arrow">-></span></span> | ||
| <span><span class="xref-unresolved">Bos</span>.Cmd.t <span class="arrow">-></span></span> | ||
| <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-manifest_push_cli"><a href="#val-manifest_push_cli" class="anchor"></a><code><span><span class="keyword">val</span> manifest_push_cli : | ||
| <span>platforms:<span>string list</span> <span class="arrow">-></span></span> | ||
| <span>template:string <span class="arrow">-></span></span> | ||
| <span>target:string <span class="arrow">-></span></span> | ||
| <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-manifest_push_file"><a href="#val-manifest_push_file" class="anchor"></a><code><span><span class="keyword">val</span> manifest_push_file : <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div></div></body></html> | ||
| <span><span class="label">platforms</span>:<span>string list</span> <span class="arrow">-></span></span> | ||
| <span><span class="label">template</span>:string <span class="arrow">-></span></span> | ||
| <span><span class="label">target</span>:string <span class="arrow">-></span></span> | ||
| <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-manifest_push_file"><a href="#val-manifest_push_file" class="anchor"></a><code><span><span class="keyword">val</span> manifest_push_file : <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div></div></body></html> |
16 changes: 8 additions & 8 deletions
16
doc/dockerfile/dockerfile-cmd/Dockerfile_cmd/Gen/index.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,20 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Gen (dockerfile-cmd.Dockerfile_cmd.Gen)</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">dockerfile-cmd</a> » <a href="../index.html">Dockerfile_cmd</a> » Gen</nav><header class="odoc-preamble"><h1>Module <code><span>Dockerfile_cmd.Gen</span></code></h1><p>Utility functions to generate Dockerfiles.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-generate_dockerfile"><a href="#val-generate_dockerfile" class="anchor"></a><code><span><span class="keyword">val</span> generate_dockerfile : | ||
| <span>?fname:string <span class="arrow">-></span></span> | ||
| <span>?crunch:bool <span class="arrow">-></span></span> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Gen (dockerfile-cmd.Dockerfile_cmd.Gen)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">dockerfile-cmd</a> » <a href="../index.html">Dockerfile_cmd</a> » Gen</nav><header class="odoc-preamble"><h1>Module <code><span>Dockerfile_cmd.Gen</span></code></h1><p>Utility functions to generate Dockerfiles.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-generate_dockerfile"><a href="#val-generate_dockerfile" class="anchor"></a><code><span><span class="keyword">val</span> generate_dockerfile : | ||
| <span><span class="optlabel">?fname</span>:string <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?crunch</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> | ||
| <span><a href="../../../dockerfile/Dockerfile/index.html#type-t">Dockerfile.t</a> <span class="arrow">-></span></span> | ||
| <span><span>(unit, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>generate_dockerfile output_dir docker</code> will output Dockerfile inside the <code>output_dir</code> subdirectory.</p><p>The <code>crunch</code> argument defaults to true and applies the <a href="../../../dockerfile/Dockerfile/index.html#val-crunch"><code>Dockerfile.crunch</code></a> optimisation to reduce the number of layers; disable it if you really want more layers.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-generate_dockerfiles"><a href="#val-generate_dockerfiles" class="anchor"></a><code><span><span class="keyword">val</span> generate_dockerfiles : | ||
| <span>?crunch:bool <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?crunch</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> | ||
| <span><span><span>(string * <a href="../../../dockerfile/Dockerfile/index.html#type-t">Dockerfile.t</a>)</span> list</span> <span class="arrow">-></span></span> | ||
| <span><span>(unit, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>generate_dockerfiles output_dir (name * docker)</code> will output a list of Dockerfiles inside the <code>output_dir/</code> subdirectory, with each Dockerfile named as <code>Dockerfile.<release></code>.</p><p>The <code>crunch</code> argument defaults to true and applies the <a href="../../../dockerfile/Dockerfile/index.html#val-crunch"><code>Dockerfile.crunch</code></a> optimisation to reduce the number of layers; disable it if you really want more layers.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-generate_dockerfiles_in_directories"><a href="#val-generate_dockerfiles_in_directories" class="anchor"></a><code><span><span class="keyword">val</span> generate_dockerfiles_in_directories : | ||
| <span>?crunch:bool <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?crunch</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> | ||
| <span><span><span>(string * <a href="../../../dockerfile/Dockerfile/index.html#type-t">Dockerfile.t</a>)</span> list</span> <span class="arrow">-></span></span> | ||
| <span><span>(unit, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>generate_dockerfiles_in_directories output_dir (name * docker)</code> will output a list of Dockerfiles inside the <code>output_dir/name</code> subdirectory, with each directory containing the Dockerfile specified by <code>docker</code>.</p><p>The <code>crunch</code> argument defaults to true and applies the <a href="../../../dockerfile/Dockerfile/index.html#val-crunch"><code>Dockerfile.crunch</code></a> optimisation to reduce the number of layers; disable it if you really want more layers.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-generate_dockerfiles_in_git_branches"><a href="#val-generate_dockerfiles_in_git_branches" class="anchor"></a><code><span><span class="keyword">val</span> generate_dockerfiles_in_git_branches : | ||
| <span>?readme:string <span class="arrow">-></span></span> | ||
| <span>?crunch:bool <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?readme</span>:string <span class="arrow">-></span></span> | ||
| <span><span class="optlabel">?crunch</span>:bool <span class="arrow">-></span></span> | ||
| <span><span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> | ||
| <span><span><span>(string * <a href="../../../dockerfile/Dockerfile/index.html#type-t">Dockerfile.t</a>)</span> list</span> <span class="arrow">-></span></span> | ||
| <span><span>(unit, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>generate_dockerfiles_in_git_branches output_dir (name * docker)</code> will output a set of git branches in the <code>output_dir</code> Git repository. Each branch will be named <code>name</code> and contain a single <code>docker</code> file. The contents of these branches will be reset, so this should be only be used on an <code>output_dir</code> that is a dedicated Git repository for this purpose. If <code>readme</code> is specified, the contents will be written to <code>README.md</code> in that branch.</p><p>The <code>crunch</code> argument defaults to true and applies the <a href="../../../dockerfile/Dockerfile/index.html#val-crunch"><code>Dockerfile.crunch</code></a> optimisation to reduce the number of layers; disable it if you really want more layers.</p></div></div></div></body></html> | ||
| <span><span>(unit, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>generate_dockerfiles_in_git_branches output_dir (name * docker)</code> will output a set of git branches in the <code>output_dir</code> Git repository. Each branch will be named <code>name</code> and contain a single <code>docker</code> file. The contents of these branches will be reset, so this should be only be used on an <code>output_dir</code> that is a dedicated Git repository for this purpose. If <code>readme</code> is specified, the contents will be written to <code>README.md</code> in that branch.</p><p>The <code>crunch</code> argument defaults to true and applies the <a href="../../../dockerfile/Dockerfile/index.html#val-crunch"><code>Dockerfile.crunch</code></a> optimisation to reduce the number of layers; disable it if you really want more layers.</p></div></div></div></body></html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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>Opam (dockerfile-cmd.Dockerfile_cmd.Opam)</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">dockerfile-cmd</a> » <a href="../index.html">Dockerfile_cmd</a> » Opam</nav><header class="odoc-preamble"><h1>Module <code><span>Dockerfile_cmd.Opam</span></code></h1><p>Opam2 command invocation</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-bin"><a href="#val-bin" class="anchor"></a><code><span><span class="keyword">val</span> bin : <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-opam_env"><a href="#val-opam_env" class="anchor"></a><code><span><span class="keyword">val</span> opam_env : | ||
| <span>root:<span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> | ||
| <span>jobs:int <span class="arrow">-></span></span> | ||
| <span><span>(<span>string <span class="xref-unresolved">Astring</span>.String.map</span>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Opam (dockerfile-cmd.Dockerfile_cmd.Opam)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.4"/><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">dockerfile-cmd</a> » <a href="../index.html">Dockerfile_cmd</a> » Opam</nav><header class="odoc-preamble"><h1>Module <code><span>Dockerfile_cmd.Opam</span></code></h1><p>Opam2 command invocation</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-bin"><a href="#val-bin" class="anchor"></a><code><span><span class="keyword">val</span> bin : <span class="xref-unresolved">Bos</span>.Cmd.t</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-opam_env"><a href="#val-opam_env" class="anchor"></a><code><span><span class="keyword">val</span> opam_env : | ||
| <span><span class="label">root</span>:<span class="xref-unresolved">Fpath</span>.t <span class="arrow">-></span></span> | ||
| <span><span class="label">jobs</span>:int <span class="arrow">-></span></span> | ||
| <span><span>(<span>string <span class="xref-unresolved">Astring</span>.String.map</span>, <span>[> <span>`Msg of string</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div></div></body></html> |
Oops, something went wrong.