1dune-compute(1)                   Dune Manual                  dune-compute(1)
2
3
4

NAME

6       dune-compute - Compute internal function.
7

SYNOPSIS

9       dune compute [OPTION]... FUNCTION [INPUT]
10

DESCRIPTION

12       Run a registered memoize function with the given input and print the
13       output.
14
15       This should only be used for debugging dune.
16

ARGUMENTS

18       FUNCTION (required)
19           Compute FUNCTION for a given input.
20
21       INPUT
22           Use INPUT as the input to the function.
23

OPTIONS

25       --build-info
26           Show build information.
27
28       -f, --force
29           Force actions associated to aliases to be re-executed even if their
30           dependencies haven't changed.
31
32       --help[=FMT] (default=auto)
33           Show this help in format FMT. The value FMT must be one of `auto',
34           `pager', `groff' or `plain'. With `auto', the format is `pager` or
35           `plain' whenever the TERM env var is `dumb' or undefined.
36
37       --sandbox=VAL (absent DUNE_SANDBOX env)
38           Sandboxing mode to use by default. Some actions require a certain
39           sandboxing mode, so they will ignore this setting. The allowed
40           values are: none, symlink, copy.
41
42       --version
43           Show version information.
44
45       -w, --watch
46           Instead of terminating build after completion, wait continuously
47           for file changes.
48

COMMON OPTIONS

50       These options are common to all commands.
51
52       --always-show-command-line
53           Always show the full command lines of programs executed by dune
54
55       --auto-promote
56           Automatically promote files. This is similar to running dune
57           promote after the build.
58
59       --build-dir=FILE (absent DUNE_BUILD_DIR env)
60           Specified build directory. _build if unspecified
61
62       --cache=VAL (absent DUNE_CACHE env)
63           Activate binary cache (either `disabled' or `enabled'). Default is
64           `disabled'.
65
66       --cache-check-probability=VAL (absent=0. or
67       DUNE_CACHE_CHECK_PROBABILITY env)
68           Probability cached rules are rerun to check for reproducibility
69
70       --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
71           Binary cache duplication mode
72
73       --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
74           Binary cache protocol
75
76       --config-file=FILE
77           Load this configuration file instead of the default one.
78
79       --debug-artifact-substitution
80           Print debugging info about artifact substitution
81
82       --debug-backtraces
83           Always print exception backtraces.
84
85       --debug-dependency-path
86           In case of error, print the dependency path from the targets on the
87           command line to the rule that failed.
88
89       --debug-findlib
90           Debug the findlib sub-system.
91
92       --default-target=TARGET (absent=@@default)
93           Set the default target that when none is specified to dune build.
94
95       --diff-command=VAL
96           Shell command to use to diff files. Use - to disable printing the
97           diff.
98
99       --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
100           Disable all promotion rules
101
102       --display=MODE
103           Control the display mode of Dune. See dune-config(5) for more
104           details.
105
106       --ignore-promoted-rules
107           Ignore rules with (mode promote), except ones with (only ...). The
108           variable %{ignoring_promoted_rules} in dune files reflects whether
109           this option was passed or not.
110
111       --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
112           "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
113           list of library names, each one of which must declare an
114           instrumentation backend.
115
116       -j JOBS
117           Run no more than JOBS commands simultaneously.
118
119       --no-buffer
120           Do not buffer the output of commands executed by dune. By default
121           dune buffers the output of subcommands, in order to prevent
122           interleaving when multiple commands are executed in parallel.
123           However, this can be an issue when debugging long running tests.
124           With --no-buffer, commands have direct access to the terminal. Note
125           that as a result their output won't be captured in the log file.
126           You should use this option in conjunction with -j 1, to avoid
127           interleaving. Additionally you should use --verbose as well, to
128           make sure that commands are printed before they are being executed.
129
130       --no-config
131           Do not load the configuration file
132
133       --no-print-directory
134           Suppress "Entering directory" messages
135
136       --only-packages=PACKAGES
137           Ignore stanzas referring to a package that is not in PACKAGES.
138           PACKAGES is a comma-separated list of package names. Note that this
139           has the same effect as deleting the relevant stanzas from dune
140           files. It is mostly meant for releases. During development, it is
141           likely that what you want instead is to build a particular
142           <package>.install target.
143
144       -p PACKAGES, --for-release-of-packages=PACKAGES
145           Shorthand for --release --only-packages PACKAGE. You must use this
146           option in your <package>.opam files, in order to build only what's
147           necessary when your project contains multiple packages as well as
148           getting reproducible builds.
149
150       --profile=VAL (absent DUNE_PROFILE env)
151           Select the build profile, for instance dev or release. The default
152           is dev.
153
154       --promote-install-files
155           Promote the generated <package>.install files to the source tree
156
157       --release
158           Put dune into a reproducible release mode. This is in fact a
159           shorthand for --root . --ignore-promoted-rules --no-config
160           --profile release --always-show-command-line
161           --promote-install-files --default-target @install. You should use
162           this option for release builds. For instance, you must use this
163           option in your <package>.opam files. Except if you already use -p,
164           as -p implies this option.
165
166       --root=DIR
167           Use this directory as workspace root instead of guessing it. Note
168           that this option doesn't change the interpretation of targets given
169           on the command line. It is only intended for scripts.
170
171       --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
172           Store original source location in dune-package metadata
173
174       --terminal-persistence=MODE
175            Changes how the log of build results are displayed to the console
176           between rebuilds while in --watch mode.
177
178       --trace-file=FILE
179           Output trace data in catapult format (compatible with
180           chrome://tracing)
181
182       --verbose
183           Same as --display verbose
184
185       --workspace=FILE (absent DUNE_WORKSPACE env)
186           Use this specific workspace file instead of looking it up.
187
188       -x VAL
189           Cross-compile using this toolchain.
190

MORE HELP

192       Use `dune COMMAND --help' for help on a single command.
193

ENVIRONMENT

195       These environment variables affect the execution of compute:
196
197       DUNE_BUILD_DIR
198           Specified build directory. _build if unspecified
199
200       DUNE_CACHE
201           Activate binary cache (either `disabled' or `enabled'). Default is
202           `disabled'.
203
204       DUNE_CACHE_CHECK_PROBABILITY
205           Probability cached rules are rerun to check for reproducibility
206
207       DUNE_CACHE_DUPLICATION
208           Binary cache duplication mode
209
210       DUNE_CACHE_TRANSPORT
211           Binary cache protocol
212
213       DUNE_DISABLE_PROMOTION
214           Disable all promotion rules
215
216       DUNE_INSTRUMENT_WITH
217           "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
218           list of library names, each one of which must declare an
219           instrumentation backend.
220
221       DUNE_PROFILE
222           Build profile. dev if unspecified or release if -p is set.
223
224       DUNE_SANDBOX
225           Sandboxing mode to use by default. (see --sandbox)
226
227       DUNE_STORE_ORIG_SOURCE_DIR
228           Store original source location in dune-package metadata
229
230       DUNE_WORKSPACE
231           Use this specific workspace file instead of looking it up.
232

BUGS

234       Check bug reports at https://github.com/ocaml/dune/issues
235
236
237
238Dune n/a                                                       dune-compute(1)
Impressum