1dune-runtest(1) Dune Manual dune-runtest(1)
2
6 dune-runtest - Run tests.
7
9 dune runtest [OPTION]... [DIR]...
10
12 This is a short-hand for calling:
13 dune build @runtest
15
17 --build-info
18 Show build information.
19 -f, --force
21 Force actions associated to aliases to be re-executed even if their
22 dependencies haven't changed.
23 --help[=FMT] (default=auto)
25 Show this help in format FMT. The value FMT must be one of `auto',
26 `pager', `groff' or `plain'. With `auto', the format is `pager` or
27 `plain' whenever the TERM env var is `dumb' or undefined.
28 --sandbox=VAL (absent DUNE_SANDBOX env)
30 Sandboxing mode to use by default. Some actions require a certain
31 sandboxing mode, so they will ignore this setting. The allowed
32 values are: none, symlink, copy.
33 --version
35 Show version information.
36 -w, --watch
38 Instead of terminating build after completion, wait continuously
39 for file changes.
40
42 These options are common to all commands.
43 --always-show-command-line
45 Always show the full command lines of programs executed by dune
46 --auto-promote
48 Automatically promote files. This is similar to running dune
49 promote after the build.
50 --build-dir=FILE (absent DUNE_BUILD_DIR env)
52 Specified build directory. _build if unspecified
53 --cache=VAL (absent DUNE_CACHE env)
55 Activate binary cache (either `disabled' or `enabled'). Default is
56 `disabled'.
57 --cache-check-probability=VAL (absent=0. or
59 DUNE_CACHE_CHECK_PROBABILITY env)
60 Probability cached rules are rerun to check for reproducibility
61 --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
63 Binary cache duplication mode
64 --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
66 Binary cache protocol
67 --config-file=FILE
69 Load this configuration file instead of the default one.
70 --debug-backtraces
72 Always print exception backtraces.
73 --debug-dependency-path
75 In case of error, print the dependency path from the targets on the
76 command line to the rule that failed.
77 --debug-findlib
79 Debug the findlib sub-system.
80 --default-target=TARGET (absent=@@default)
82 Set the default target that when none is specified to dune build.
83 --diff-command=VAL
85 Shell command to use to diff files. Use - to disable printing the
86 diff.
87 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
89 Disable all promotion rules
90 --display=MODE
92 Control the display mode of Dune. See dune-config(5) for more
93 details.
94 --ignore-promoted-rules
96 Ignore rules with (mode promote), except ones with (only ...). The
97 variable %{ignoring_promoted_rules} in dune files reflects whether
98 this option was passed or not.
99 -j JOBS
101 Run no more than JOBS commands simultaneously.
102 --no-buffer
104 Do not buffer the output of commands executed by dune. By default
105 dune buffers the output of subcommands, in order to prevent
106 interleaving when multiple commands are executed in parallel.
107 However, this can be an issue when debugging long running tests.
108 With --no-buffer, commands have direct access to the terminal. Note
109 that as a result their output won't be captured in the log file.
110 You should use this option in conjunction with -j 1, to avoid
111 interleaving. Additionally you should use --verbose as well, to
112 make sure that commands are printed before they are being executed.
113 --no-config
115 Do not load the configuration file
116 --no-print-directory
118 Suppress "Entering directory" messages
119 --only-packages=PACKAGES
121 Ignore stanzas referring to a package that is not in PACKAGES.
122 PACKAGES is a comma-separated list of package names. Note that this
123 has the same effect as deleting the relevant stanzas from dune
124 files. It is mostly meant for releases. During development, it is
125 likely that what you want instead is to build a particular
126 <package>.install target.
127 -p PACKAGES, --for-release-of-packages=PACKAGES
129 Shorthand for --release --only-packages PACKAGE. You must use this
130 option in your <package>.opam files, in order to build only what's
131 necessary when your project contains multiple packages as well as
132 getting reproducible builds.
133 --profile=VAL (absent DUNE_PROFILE env)
135 Select the build profile, for instance dev or release. The default
136 is dev.
137 --promote-install-files
139 Promote the generated <package>.install files to the source tree
140 --release
142 Put dune into a reproducible release mode. This is in fact a
143 shorthand for --root . --ignore-promoted-rules --no-config
144 --profile release --always-show-command-line
145 --promote-install-files --default-target @install. You should use
146 this option for release builds. For instance, you must use this
147 option in your <package>.opam files. Except if you already use -p,
148 as -p implies this option.
149 --root=DIR
151 Use this directory as workspace root instead of guessing it. Note
152 that this option doesn't change the interpretation of targets given
153 on the command line. It is only intended for scripts.
154 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
156 Store original source location in dune-package metadata
157 --terminal-persistence=MODE
159 Changes how the log of build results are displayed to the console
160 between rebuilds while in --watch mode.
161 --trace-file=FILE
163 Output trace data in catapult format (compatible with
164 chrome://tracing)
165 --verbose
167 Same as --display verbose
168 --workspace=FILE (absent DUNE_WORKSPACE env)
170 Use this specific workspace file instead of looking it up.
171 -x VAL
173 Cross-compile using this toolchain.
174
176 Use `dune COMMAND --help' for help on a single command.
177
179 These environment variables affect the execution of runtest:
180 DUNE_BUILD_DIR
182 Specified build directory. _build if unspecified
183 DUNE_CACHE
185 Activate binary cache (either `disabled' or `enabled'). Default is
186 `disabled'.
187 DUNE_CACHE_CHECK_PROBABILITY
189 Probability cached rules are rerun to check for reproducibility
190 DUNE_CACHE_DUPLICATION
192 Binary cache duplication mode
193 DUNE_CACHE_TRANSPORT
195 Binary cache protocol
196 DUNE_DISABLE_PROMOTION
198 Disable all promotion rules
199 DUNE_PROFILE
201 Build profile. dev if unspecified or release if -p is set.
202 DUNE_SANDBOX
204 Sandboxing mode to use by default. (see --sandbox)
205 DUNE_STORE_ORIG_SOURCE_DIR
207 Store original source location in dune-package metadata
208 DUNE_WORKSPACE
210 Use this specific workspace file instead of looking it up.
211
213 Check bug reports at https://github.com/ocaml/dune/issues
214
216 1. Run all tests in the current source tree (including those that
217 passed on the last run):
218 dune runtest --force
220 2. Run tests sequentially without output buffering:
222 dune runtest --no-buffer -j 1
224Dune n/a dune-runtest(1)