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