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

NAME

6       dune-shutdown - cancel and shutdown any builds in the current workspace
7

SYNOPSIS

9       dune shutdown [OPTION]…
10

OPTIONS

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

COMMON OPTIONS

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

EXIT STATUS

259       shutdown exits with the following status:
260
261       0   on success.
262
263       123 on indiscriminate errors reported on standard error.
264
265       124 on command line parsing errors.
266
267       125 on unexpected internal errors (bugs).
268

ENVIRONMENT

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

SEE ALSO

314       dune(1)
315
316
317
318Dune n/a                                                      DUNE-SHUTDOWN(1)
Impressum