1DUNE-TEST(1)                      Dune Manual                     DUNE-TEST(1)
2
3
4

NAME

6       dune-test - An alias for runtest.
7

SYNOPSIS

9       dune test [OPTION]… [DIR]…
10

DESCRIPTION

12       dune test is an alias for dune runtest.
13
14       See dune runtest --help for details.
15

OPTIONS

17       --action-stderr-on-success=VAL
18           Same as --action-stdout-on-success but for the standard output for
19           error messages. A good default for large mono-repositories is
20           --action-stdout-on-success=swallow
21           --action-stderr-on-success=must-be-empty. This ensures that a
22           successful build has a "clean" empty output.
23
24       --action-stdout-on-success=VAL
25           Specify how to deal with the standard output of actions when they
26           succeed. Possible values are: print to just print it to Dune's
27           output, swallow to completely ignore it and must-be-empty to
28           enforce that the action printed nothing. With must-be-empty, Dune
29           will consider that the action failed if it printed something to its
30           standard output. The default is print.
31
32       --build-info
33           Show build information.
34
35       --error-reporting=VAL (absent=deterministic)
36           Controls when the build errors are reported. early - report errors
37           as soon as they are discovered. deterministic - report errors at
38           the end of the build in a deterministic order. twice - report each
39           error twice: once as soon as the error is discovered and then again
40           at the end of the build, in a deterministic order.
41
42       -f, --force
43           Force actions associated to aliases to be re-executed even if their
44           dependencies haven't changed.
45
46       --file-watcher=VAL (absent=automatic)
47           Mechanism to detect changes in the source. Automatic to make dune
48           run an external program to detect changes. Manual to notify dune
49           that files have changed manually."
50
51       --passive-watch-mode
52           Similar to [--watch], but only start a build when instructed
53           externally by an RPC.
54
55       --react-to-insignificant-changes
56           react to insignificant file system changes; this is only useful for
57           benchmarking dune
58
59       --sandbox=VAL (absent DUNE_SANDBOX env)
60           Sandboxing mode to use by default. Some actions require a certain
61           sandboxing mode, so they will ignore this setting. The allowed
62           values are: none, symlink, copy, hardlink.
63
64       -w, --watch
65           Instead of terminating build after completion, wait continuously
66           for file changes.
67
68       --wait-for-filesystem-clock
69           Dune digest file contents for better incrementally. These digests
70           are themselves cached. In some cases, Dune needs to drop some
71           digest cache entries in order for things to be reliable. This
72           option makes Dune wait for the file system clock to advance so that
73           it doesn't need to drop anything. You should probably not care
74           about this option; it is mostly useful for Dune developers to make
75           Dune tests of the digest cache more reproducible.
76

COMMON OPTIONS

78       These options are common to all commands.
79
80       --always-show-command-line
81           Always show the full command lines of programs executed by dune
82
83       --auto-promote
84           Automatically promote files. This is similar to running dune
85           promote after the build.
86
87       --build-dir=FILE (absent DUNE_BUILD_DIR env)
88           Specified build directory. _build if unspecified
89
90       --cache=VAL (absent DUNE_CACHE env)
91           Enable or disable Dune cache (either enabled or disabled). Default
92           is `disabled'.
93
94       --cache-check-probability=VAL (absent DUNE_CACHE_CHECK_PROBABILITY env)
95           Check build reproducibility by re-executing randomly chosen rules
96           and comparing their results with those stored in Dune cache. Note:
97           by increasing the probability of such checks you slow down the
98           build. The default probability is zero, i.e. no rules are checked.
99
100       --cache-storage-mode=VAL (absent DUNE_CACHE_STORAGE_MODE env)
101           Dune cache storage mode (one of auto, hardlink or copy). Default is
102           `auto'.
103
104       --config-file=FILE
105           Load this configuration file instead of the default one.
106
107       --debug-artifact-substitution
108           Print debugging info about artifact substitution
109
110       --debug-backtraces
111           Always print exception backtraces.
112
113       --debug-cache=VAL
114           Show debug messages on cache misses for the given cache layers.
115           Value is a comma-separated list of cache layer names. All available
116           cache layers: shared,workspace-local,fs.
117
118       --debug-dependency-path
119           In case of error, print the dependency path from the targets on the
120           command line to the rule that failed.
121
122       --debug-digests
123           Explain why Dune decides to re-digest some files
124
125       --debug-findlib
126           Debug the findlib sub-system.
127
128       --debug-load-dir
129           Print debugging info about directory loading
130
131       --debug-store-digest-preimage
132           Store digest preimage for all computed digests, so that it's
133           possible to reverse them later, for debugging. The digests are
134           stored in the shared cache (see --cache flag) as values, even if
135           cache is otherwise disabled. This should be used only for
136           debugging, since it's slow and it litters the shared cache.
137
138       --default-target=TARGET (absent=@@default)
139           Set the default target that when none is specified to dune build.
140
141       --diff-command=VAL (absent DUNE_DIFF_COMMAND env)
142           Shell command to use to diff files. Use - to disable printing the
143           diff.
144
145       --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
146           Disable all promotion rules
147
148       --display=MODE
149           Control the display mode of Dune. See dune-config(5) for more
150           details.
151
152       --dump-memo-graph=FILE
153           Dumps the dependency graph to a file after the build is complete
154
155       --dump-memo-graph-format=FORMAT (absent=gexf)
156           File format to be used when dumping dependency graph
157
158       --dump-memo-graph-with-timing
159           With --dump-memo-graph, will re-run each cached node in the Memo
160           graph after building and include the runtime in the output. Since
161           all nodes contain a cached value, this will measure just the
162           runtime of each node
163
164       --help[=FMT] (default=auto)
165           Show this help in format FMT. The value FMT must be one of auto,
166           pager, groff or plain. With auto, the format is pager or plain
167           whenever the TERM env var is dumb or undefined.
168
169       --ignore-promoted-rules
170           Ignore rules with (mode promote), except ones with (only ...). The
171           variable %{ignoring_promoted_rules} in dune files reflects whether
172           this option was passed or not.
173
174       --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
175           "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
176           list of library names, each one of which must declare an
177           instrumentation backend.
178
179       -j JOBS
180           Run no more than JOBS commands simultaneously.
181
182       --no-buffer
183           Do not buffer the output of commands executed by dune. By default
184           dune buffers the output of subcommands, in order to prevent
185           interleaving when multiple commands are executed in parallel.
186           However, this can be an issue when debugging long running tests.
187           With --no-buffer, commands have direct access to the terminal. Note
188           that as a result their output won't be captured in the log file.
189           You should use this option in conjunction with -j 1, to avoid
190           interleaving. Additionally you should use --verbose as well, to
191           make sure that commands are printed before they are being executed.
192
193       --no-config
194           Do not load the configuration file
195
196       --no-print-directory
197           Suppress "Entering directory" messages
198
199       --only-packages=PACKAGES
200           Ignore stanzas referring to a package that is not in PACKAGES.
201           PACKAGES is a comma-separated list of package names. Note that this
202           has the same effect as deleting the relevant stanzas from dune
203           files. It is mostly meant for releases. During development, it is
204           likely that what you want instead is to build a particular
205           <package>.install target.
206
207       -p PACKAGES, --for-release-of-packages=PACKAGES (required)
208           Shorthand for --release --only-packages PACKAGE. You must use this
209           option in your <package>.opam files, in order to build only what's
210           necessary when your project contains multiple packages as well as
211           getting reproducible builds.
212
213       --print-metrics
214           Print out various performance metrics after every build
215
216       --profile=VAL (absent DUNE_PROFILE env)
217           Select the build profile, for instance dev or release. The default
218           is dev.
219
220       --promote-install-files[=VAL] (default=true)
221           Promote the generated <package>.install files to the source tree
222
223       --release
224           Put dune into a reproducible release mode. This is in fact a
225           shorthand for --root . --ignore-promoted-rules --no-config
226           --profile release --always-show-command-line
227           --promote-install-files --default-target @install
228           --require-dune-project-file. You should use this option for release
229           builds. For instance, you must use this option in your
230           <package>.opam files. Except if you already use -p, as -p implies
231           this option.
232
233       --require-dune-project-file[=VAL] (default=true)
234           Fail if a dune-project file is missing.
235
236       --root=DIR
237           Use this directory as workspace root instead of guessing it. Note
238           that this option doesn't change the interpretation of targets given
239           on the command line. It is only intended for scripts.
240
241       --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
242           Store original source location in dune-package metadata
243
244       --terminal-persistence=MODE
245           Changes how the log of build results are displayed to the console
246           between rebuilds while in --watch mode. Supported modes: preserve,
247           clear-on-rebuild, clear-on-rebuild-and-flush-history.
248
249       --trace-file=FILE
250           Output trace data in catapult format (compatible with
251           chrome://tracing)
252
253       --verbose
254           Same as --display verbose
255
256       --version
257           Show version information.
258
259       --workspace=FILE (absent DUNE_WORKSPACE env)
260           Use this specific workspace file instead of looking it up.
261
262       -x VAL
263           Cross-compile using this toolchain.
264

MORE HELP

266       Use `dune COMMAND --help' for help on a single command.
267

EXIT STATUS

269       test exits with the following status:
270
271       0   on success.
272
273       123 on indiscriminate errors reported on standard error.
274
275       124 on command line parsing errors.
276
277       125 on unexpected internal errors (bugs).
278

ENVIRONMENT

280       These environment variables affect the execution of test:
281
282       DUNE_BUILD_DIR
283           Specified build directory. _build if unspecified
284
285       DUNE_CACHE
286           Enable or disable Dune cache (either enabled or disabled). Default
287           is `disabled'.
288
289       DUNE_CACHE_CHECK_PROBABILITY
290           Check build reproducibility by re-executing randomly chosen rules
291           and comparing their results with those stored in Dune cache. Note:
292           by increasing the probability of such checks you slow down the
293           build. The default probability is zero, i.e. no rules are checked.
294
295       DUNE_CACHE_STORAGE_MODE
296           Dune cache storage mode (one of auto, hardlink or copy). Default is
297           `auto'.
298
299       DUNE_DIFF_COMMAND
300           Shell command to use to diff files. Use - to disable printing the
301           diff.
302
303       DUNE_DISABLE_PROMOTION
304           Disable all promotion rules
305
306       DUNE_INSTRUMENT_WITH
307           "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
308           list of library names, each one of which must declare an
309           instrumentation backend.
310
311       DUNE_PROFILE
312           Build profile. dev if unspecified or release if -p is set.
313
314       DUNE_SANDBOX
315           Sandboxing mode to use by default. (see --sandbox)
316
317       DUNE_STORE_ORIG_SOURCE_DIR
318           Store original source location in dune-package metadata
319
320       DUNE_WORKSPACE
321           Use this specific workspace file instead of looking it up.
322

BUGS

324       Check bug reports at https://github.com/ocaml/dune/issues
325

SEE ALSO

327       dune(1)
328
329
330
331Dune n/a                                                          DUNE-TEST(1)
Impressum