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-findlib
132 Debug the findlib sub-system.
133 --debug-load-dir
135 Print debugging info about directory loading
136 --debug-store-digest-preimage
138 Store digest preimage for all computed digests, so that it's
139 possible to reverse them later, for debugging. The digests are
140 stored in the shared cache (see --cache flag) as values, even if
141 cache is otherwise disabled. This should be used only for
142 debugging, since it's slow and it litters the shared cache.
143 --default-target=TARGET (absent=@@default)
145 Set the default target that when none is specified to dune build.
146 --diff-command=VAL (absent DUNE_DIFF_COMMAND env)
148 Shell command to use to diff files. Use - to disable printing the
149 diff.
150 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
152 Disable all promotion rules
153 --display=MODE
155 Control the display mode of Dune. See dune-config(5) for more
156 details.
157 --dump-memo-graph=FILE
159 Dumps the dependency graph to a file after the build is complete
160 --dump-memo-graph-format=FORMAT (absent=gexf)
162 File format to be used when dumping dependency graph
163 --dump-memo-graph-with-timing
165 With --dump-memo-graph, will re-run each cached node in the Memo
166 graph after building and include the runtime in the output. Since
167 all nodes contain a cached value, this will measure just the
168 runtime of each node
169 --help[=FMT] (default=auto)
171 Show this help in format FMT. The value FMT must be one of auto,
172 pager, groff or plain. With auto, the format is pager or plain
173 whenever the TERM env var is dumb or undefined.
174 --ignore-promoted-rules
176 Ignore rules with (mode promote), except ones with (only ...). The
177 variable %{ignoring_promoted_rules} in dune files reflects whether
178 this option was passed or not.
179 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
181 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
182 list of library names, each one of which must declare an
183 instrumentation backend.
184 -j JOBS
186 Run no more than JOBS commands simultaneously.
187 --no-buffer
189 Do not buffer the output of commands executed by dune. By default
190 dune buffers the output of subcommands, in order to prevent
191 interleaving when multiple commands are executed in parallel.
192 However, this can be an issue when debugging long running tests.
193 With --no-buffer, commands have direct access to the terminal. Note
194 that as a result their output won't be captured in the log file.
195 You should use this option in conjunction with -j 1, to avoid
196 interleaving. Additionally you should use --verbose as well, to
197 make sure that commands are printed before they are being executed.
198 --no-config
200 Do not load the configuration file
201 --no-print-directory
203 Suppress "Entering directory" messages
204 --only-packages=PACKAGES
206 Ignore stanzas referring to a package that is not in PACKAGES.
207 PACKAGES is a comma-separated list of package names. Note that this
208 has the same effect as deleting the relevant stanzas from dune
209 files. It is mostly meant for releases. During development, it is
210 likely that what you want instead is to build a particular
211 <package>.install target.
212 -p PACKAGES, --for-release-of-packages=PACKAGES (required)
214 Shorthand for --release --only-packages PACKAGE. You must use this
215 option in your <package>.opam files, in order to build only what's
216 necessary when your project contains multiple packages as well as
217 getting reproducible builds.
218 --print-metrics
220 Print out various performance metrics after every build
221 --profile=VAL (absent DUNE_PROFILE env)
223 Select the build profile, for instance dev or release. The default
224 is dev.
225 --promote-install-files[=VAL] (default=true)
227 Promote the generated <package>.install files to the source tree
228 --release
230 Put dune into a reproducible release mode. This is in fact a
231 shorthand for --root . --ignore-promoted-rules --no-config
232 --profile release --always-show-command-line
233 --promote-install-files --default-target @install
234 --require-dune-project-file. You should use this option for release
235 builds. For instance, you must use this option in your
236 <package>.opam files. Except if you already use -p, as -p implies
237 this option.
238 --require-dune-project-file[=VAL] (default=true)
240 Fail if a dune-project file is missing.
241 --root=DIR
243 Use this directory as workspace root instead of guessing it. Note
244 that this option doesn't change the interpretation of targets given
245 on the command line. It is only intended for scripts.
246 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
248 Store original source location in dune-package metadata
249 --terminal-persistence=MODE
251 Changes how the log of build results are displayed to the console
252 between rebuilds while in --watch mode. Supported modes: preserve,
253 clear-on-rebuild, clear-on-rebuild-and-flush-history.
254 --trace-file=FILE
256 Output trace data in catapult format (compatible with
257 chrome://tracing)
258 --verbose
260 Same as --display verbose
261 --version
263 Show version information.
264 --workspace=FILE (absent DUNE_WORKSPACE env)
266 Use this specific workspace file instead of looking it up.
267 -x VAL
269 Cross-compile using this toolchain.
270
272 Use `dune COMMAND --help' for help on a single command.
273
275 top exits with the following status:
276 0 on success.
278 123 on indiscriminate errors reported on standard error.
280 124 on command line parsing errors.
282 125 on unexpected internal errors (bugs).
284
286 These environment variables affect the execution of top:
287 DUNE_BUILD_DIR
289 Specified build directory. _build if unspecified
290 DUNE_CACHE
292 Enable or disable Dune cache (either enabled or disabled). Default
293 is `disabled'.
294 DUNE_CACHE_CHECK_PROBABILITY
296 Check build reproducibility by re-executing randomly chosen rules
297 and comparing their results with those stored in Dune cache. Note:
298 by increasing the probability of such checks you slow down the
299 build. The default probability is zero, i.e. no rules are checked.
300 DUNE_CACHE_STORAGE_MODE
302 Dune cache storage mode (one of auto, hardlink or copy). Default is
303 `auto'.
304 DUNE_DIFF_COMMAND
306 Shell command to use to diff files. Use - to disable printing the
307 diff.
308 DUNE_DISABLE_PROMOTION
310 Disable all promotion rules
311 DUNE_INSTRUMENT_WITH
313 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
314 list of library names, each one of which must declare an
315 instrumentation backend.
316 DUNE_PROFILE
318 Build profile. dev if unspecified or release if -p is set.
319 DUNE_SANDBOX
321 Sandboxing mode to use by default. (see --sandbox)
322 DUNE_STORE_ORIG_SOURCE_DIR
324 Store original source location in dune-package metadata
325 DUNE_WORKSPACE
327 Use this specific workspace file instead of looking it up.
328
330 Check bug reports at https://github.com/ocaml/dune/issues
331
333 dune(1)
334Dune n/a DUNE-TOP(1)