1DUNE-TOP(1) Dune Manual DUNE-TOP(1)
2
6 dune-top - Print a list of toplevel directives for including
7 directories and loading cma files.
8
10 dune top [OPTION]… [DIR]
11
13 Print a list of toplevel directives for including directories and
14 loading cma files.
15 The output of dune toplevel-init-file should be evaluated in a toplevel
17 to make a library available there.
18
20 --action-stderr-on-success=VAL
21 Same as --action-stdout-on-success but for the standard output for
22 error messages. A good default for large mono-repositories is
23 --action-stdout-on-success=swallow
24 --action-stderr-on-success=must-be-empty. This ensures that a
25 successful build has a "clean" empty output.
26 --action-stdout-on-success=VAL
28 Specify how to deal with the standard output of actions when they
29 succeed. Possible values are: print to just print it to Dune's
30 output, swallow to completely ignore it and must-be-empty to
31 enforce that the action printed nothing. With must-be-empty, Dune
32 will consider that the action failed if it printed something to its
33 standard output. The default is print.
34 --build-info
36 Show build information.
37 --context=CONTEXT (absent=default)
39 Select context where to build/run utop.
40 --error-reporting=VAL (absent=deterministic)
42 Controls when the build errors are reported. early - report errors
43 as soon as they are discovered. deterministic - report errors at
44 the end of the build in a deterministic order. twice - report each
45 error twice: once as soon as the error is discovered and then again
46 at the end of the build, in a deterministic order.
47 -f, --force
49 Force actions associated to aliases to be re-executed even if their
50 dependencies haven't changed.
51 --file-watcher=VAL (absent=automatic)
53 Mechanism to detect changes in the source. Automatic to make dune
54 run an external program to detect changes. Manual to notify dune
55 that files have changed manually."
56 --passive-watch-mode
58 Similar to [--watch], but only start a build when instructed
59 externally by an RPC.
60 --react-to-insignificant-changes
62 react to insignificant file system changes; this is only useful for
63 benchmarking dune
64 --sandbox=VAL (absent DUNE_SANDBOX env)
66 Sandboxing mode to use by default. Some actions require a certain
67 sandboxing mode, so they will ignore this setting. The allowed
68 values are: none, symlink, copy, hardlink.
69 -w, --watch
71 Instead of terminating build after completion, wait continuously
72 for file changes.
73 --wait-for-filesystem-clock
75 Dune digest file contents for better incrementally. These digests
76 are themselves cached. In some cases, Dune needs to drop some
77 digest cache entries in order for things to be reliable. This
78 option makes Dune wait for the file system clock to advance so that
79 it doesn't need to drop anything. You should probably not care
80 about this option; it is mostly useful for Dune developers to make
81 Dune tests of the digest cache more reproducible.
82
84 These options are common to all commands.
85 --always-show-command-line
87 Always show the full command lines of programs executed by dune
88 --auto-promote
90 Automatically promote files. This is similar to running dune
91 promote after the build.
92 --build-dir=FILE (absent DUNE_BUILD_DIR env)
94 Specified build directory. _build if unspecified
95 --cache=VAL (absent DUNE_CACHE env)
97 Enable or disable Dune cache (either enabled or disabled). Default
98 is `disabled'.
99 --cache-check-probability=VAL (absent DUNE_CACHE_CHECK_PROBABILITY env)
101 Check build reproducibility by re-executing randomly chosen rules
102 and comparing their results with those stored in Dune cache. Note:
103 by increasing the probability of such checks you slow down the
104 build. The default probability is zero, i.e. no rules are checked.
105 --cache-storage-mode=VAL (absent DUNE_CACHE_STORAGE_MODE env)
107 Dune cache storage mode (one of auto, hardlink or copy). Default is
108 `auto'.
109 --config-file=FILE
111 Load this configuration file instead of the default one.
112 --debug-artifact-substitution
114 Print debugging info about artifact substitution
115 --debug-backtraces
117 Always print exception backtraces.
118 --debug-cache=VAL
120 Show debug messages on cache misses for the given cache layers.
121 Value is a comma-separated list of cache layer names. All available
122 cache layers: shared,workspace-local,fs.
123 --debug-dependency-path
125 In case of error, print the dependency path from the targets on the
126 command line to the rule that failed.
127 --debug-digests
129 Explain why Dune decides to re-digest some files
130 --debug-load-dir
132 Print debugging info about directory loading
133 --debug-store-digest-preimage
135 Store digest preimage for all computed digests, so that it's
136 possible to reverse them later, for debugging. The digests are
137 stored in the shared cache (see --cache flag) as values, even if
138 cache is otherwise disabled. This should be used only for
139 debugging, since it's slow and it litters the shared cache.
140 --default-target=TARGET (absent=@@default)
142 Set the default target that when none is specified to dune build.
143 --diff-command=VAL (absent DUNE_DIFF_COMMAND env)
145 Shell command to use to diff files. Use - to disable printing the
146 diff.
147 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
149 Disable all promotion rules
150 --display=MODE
152 Control the display mode of Dune. See dune-config(5) for more
153 details. Valid values for this option are One of progress, verbose,
154 short or quiet
155 --dump-memo-graph=FILE
157 Dumps the dependency graph to a file after the build is complete
158 --dump-memo-graph-format=FORMAT (absent=gexf)
160 File format to be used when dumping dependency graph
161 --dump-memo-graph-with-timing
163 With --dump-memo-graph, will re-run each cached node in the Memo
164 graph after building and include the runtime in the output. Since
165 all nodes contain a cached value, this will measure just the
166 runtime of each node
167 --help[=FMT] (default=auto)
169 Show this help in format FMT. The value FMT must be one of auto,
170 pager, groff or plain. With auto, the format is pager or plain
171 whenever the TERM env var is dumb or undefined.
172 --ignore-promoted-rules
174 Ignore rules with (mode promote), except ones with (only ...). The
175 variable %{ignoring_promoted_rules} in dune files reflects whether
176 this option was passed or not.
177 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
179 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
180 list of library names, each one of which must declare an
181 instrumentation backend.
182 -j JOBS
184 Run no more than JOBS commands simultaneously.
185 --no-buffer
187 Do not buffer the output of commands executed by dune. By default
188 dune buffers the output of subcommands, in order to prevent
189 interleaving when multiple commands are executed in parallel.
190 However, this can be an issue when debugging long running tests.
191 With --no-buffer, commands have direct access to the terminal. Note
192 that as a result their output won't be captured in the log file.
193 You should use this option in conjunction with -j 1, to avoid
194 interleaving. Additionally you should use --verbose as well, to
195 make sure that commands are printed before they are being executed.
196 --no-config
198 Do not load the configuration file
199 --no-print-directory
201 Suppress "Entering directory" messages
202 --only-packages=PACKAGES
204 Ignore stanzas referring to a package that is not in PACKAGES.
205 PACKAGES is a comma-separated list of package names. Note that this
206 has the same effect as deleting the relevant stanzas from dune
207 files. It is mostly meant for releases. During development, it is
208 likely that what you want instead is to build a particular
209 <package>.install target.
210 -p PACKAGES, --for-release-of-packages=PACKAGES (required)
212 Shorthand for --release --only-packages PACKAGE. You must use this
213 option in your <package>.opam files, in order to build only what's
214 necessary when your project contains multiple packages as well as
215 getting reproducible builds.
216 --print-metrics
218 Print out various performance metrics after every build
219 --profile=VAL (absent DUNE_PROFILE env)
221 Select the build profile, for instance dev or release. The default
222 is dev.
223 --promote-install-files[=VAL] (default=true)
225 Promote the generated <package>.install files to the source tree
226 --release
228 Put dune into a reproducible release mode. This is in fact a
229 shorthand for --root . --ignore-promoted-rules --no-config
230 --profile release --always-show-command-line
231 --promote-install-files --default-target @install
232 --require-dune-project-file. You should use this option for release
233 builds. For instance, you must use this option in your
234 <package>.opam files. Except if you already use -p, as -p implies
235 this option.
236 --require-dune-project-file[=VAL] (default=true)
238 Fail if a dune-project file is missing.
239 --root=DIR
241 Use this directory as workspace root instead of guessing it. Note
242 that this option doesn't change the interpretation of targets given
243 on the command line. It is only intended for scripts.
244 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
246 Store original source location in dune-package metadata
247 --terminal-persistence=MODE
249 Changes how the log of build results are displayed to the console
250 between rebuilds while in --watch mode. Supported modes: preserve,
251 clear-on-rebuild, clear-on-rebuild-and-flush-history.
252 --trace-file=FILE
254 Output trace data in catapult format (compatible with
255 chrome://tracing)
256 --verbose
258 Same as --display verbose
259 --version
261 Show version information.
262 --workspace=FILE (absent DUNE_WORKSPACE env)
264 Use this specific workspace file instead of looking it up.
265 -x VAL
267 Cross-compile using this toolchain.
268
270 Use `dune COMMAND --help' for help on a single command.
271
273 top exits with the following status:
274 0 on success.
276 123 on indiscriminate errors reported on standard error.
278 124 on command line parsing errors.
280 125 on unexpected internal errors (bugs).
282
284 These environment variables affect the execution of top:
285 DUNE_BUILD_DIR
287 Specified build directory. _build if unspecified
288 DUNE_CACHE
290 Enable or disable Dune cache (either enabled or disabled). Default
291 is `disabled'.
292 DUNE_CACHE_CHECK_PROBABILITY
294 Check build reproducibility by re-executing randomly chosen rules
295 and comparing their results with those stored in Dune cache. Note:
296 by increasing the probability of such checks you slow down the
297 build. The default probability is zero, i.e. no rules are checked.
298 DUNE_CACHE_STORAGE_MODE
300 Dune cache storage mode (one of auto, hardlink or copy). Default is
301 `auto'.
302 DUNE_DIFF_COMMAND
304 Shell command to use to diff files. Use - to disable printing the
305 diff.
306 DUNE_DISABLE_PROMOTION
308 Disable all promotion rules
309 DUNE_INSTRUMENT_WITH
311 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
312 list of library names, each one of which must declare an
313 instrumentation backend.
314 DUNE_PROFILE
316 Build profile. dev if unspecified or release if -p is set.
317 DUNE_SANDBOX
319 Sandboxing mode to use by default. (see --sandbox)
320 DUNE_STORE_ORIG_SOURCE_DIR
322 Store original source location in dune-package metadata
323 DUNE_WORKSPACE
325 Use this specific workspace file instead of looking it up.
326
328 Check bug reports at https://github.com/ocaml/dune/issues
329
331 dune(1)
332Dune n/a DUNE-TOP(1)