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 --build-info
16 Show build information.
17 -f, --force
19 Force actions associated to aliases to be re-executed even if their
20 dependencies haven't changed.
21 --help[=FMT] (default=auto)
23 Show this help in format FMT. The value FMT must be one of `auto',
24 `pager', `groff' or `plain'. With `auto', the format is `pager` or
25 `plain' whenever the TERM env var is `dumb' or undefined.
26 --sandbox=VAL (absent DUNE_SANDBOX env)
28 Sandboxing mode to use by default. Some actions require a certain
29 sandboxing mode, so they will ignore this setting. The allowed
30 values are: none, symlink, copy.
31 --version
33 Show version information.
34 -w, --watch
36 Instead of terminating build after completion, wait continuously
37 for file changes.
38
40 These options are common to all commands.
41 --always-show-command-line
43 Always show the full command lines of programs executed by dune
44 --auto-promote
46 Automatically promote files. This is similar to running dune
47 promote after the build.
48 --build-dir=FILE (absent DUNE_BUILD_DIR env)
50 Specified build directory. _build if unspecified
51 --cache=VAL (absent DUNE_CACHE env)
53 Activate binary cache (either `disabled' or `enabled'). Default is
54 `disabled'.
55 --cache-check-probability=VAL (absent=0. or
57 DUNE_CACHE_CHECK_PROBABILITY env)
58 Probability cached rules are rerun to check for reproducibility
59 --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
61 Binary cache duplication mode
62 --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
64 Binary cache protocol
65 --config-file=FILE
67 Load this configuration file instead of the default one.
68 --debug-backtraces
70 Always print exception backtraces.
71 --debug-dependency-path
73 In case of error, print the dependency path from the targets on the
74 command line to the rule that failed.
75 --debug-findlib
77 Debug the findlib sub-system.
78 --default-target=TARGET (absent=@@default)
80 Set the default target that when none is specified to dune build.
81 --diff-command=VAL
83 Shell command to use to diff files. Use - to disable printing the
84 diff.
85 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
87 Disable all promotion rules
88 --display=MODE
90 Control the display mode of Dune. See dune-config(5) for more
91 details.
92 --ignore-promoted-rules
94 Ignore rules with (mode promote), except ones with (only ...). The
95 variable %{ignoring_promoted_rules} in dune files reflects whether
96 this option was passed or not.
97 -j JOBS
99 Run no more than JOBS commands simultaneously.
100 --no-buffer
102 Do not buffer the output of commands executed by dune. By default
103 dune buffers the output of subcommands, in order to prevent
104 interleaving when multiple commands are executed in parallel.
105 However, this can be an issue when debugging long running tests.
106 With --no-buffer, commands have direct access to the terminal. Note
107 that as a result their output won't be captured in the log file.
108 You should use this option in conjunction with -j 1, to avoid
109 interleaving. Additionally you should use --verbose as well, to
110 make sure that commands are printed before they are being executed.
111 --no-config
113 Do not load the configuration file
114 --no-print-directory
116 Suppress "Entering directory" messages
117 --only-packages=PACKAGES
119 Ignore stanzas referring to a package that is not in PACKAGES.
120 PACKAGES is a comma-separated list of package names. Note that this
121 has the same effect as deleting the relevant stanzas from dune
122 files. It is mostly meant for releases. During development, it is
123 likely that what you want instead is to build a particular
124 <package>.install target.
125 -p PACKAGES, --for-release-of-packages=PACKAGES
127 Shorthand for --release --only-packages PACKAGE. You must use this
128 option in your <package>.opam files, in order to build only what's
129 necessary when your project contains multiple packages as well as
130 getting reproducible builds.
131 --profile=VAL (absent DUNE_PROFILE env)
133 Select the build profile, for instance dev or release. The default
134 is dev.
135 --promote-install-files
137 Promote the generated <package>.install files to the source tree
138 --release
140 Put dune into a reproducible release mode. This is in fact a
141 shorthand for --root . --ignore-promoted-rules --no-config
142 --profile release --always-show-command-line
143 --promote-install-files --default-target @install. You should use
144 this option for release builds. For instance, you must use this
145 option in your <package>.opam files. Except if you already use -p,
146 as -p implies this option.
147 --root=DIR
149 Use this directory as workspace root instead of guessing it. Note
150 that this option doesn't change the interpretation of targets given
151 on the command line. It is only intended for scripts.
152 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
154 Store original source location in dune-package metadata
155 --terminal-persistence=MODE
157 Changes how the log of build results are displayed to the console
158 between rebuilds while in --watch mode.
159 --trace-file=FILE
161 Output trace data in catapult format (compatible with
162 chrome://tracing)
163 --verbose
165 Same as --display verbose
166 --workspace=FILE (absent DUNE_WORKSPACE env)
168 Use this specific workspace file instead of looking it up.
169 -x VAL
171 Cross-compile using this toolchain.
172
174 Use `dune COMMAND --help' for help on a single command.
175
177 These environment variables affect the execution of upgrade:
178 DUNE_BUILD_DIR
180 Specified build directory. _build if unspecified
181 DUNE_CACHE
183 Activate binary cache (either `disabled' or `enabled'). Default is
184 `disabled'.
185 DUNE_CACHE_CHECK_PROBABILITY
187 Probability cached rules are rerun to check for reproducibility
188 DUNE_CACHE_DUPLICATION
190 Binary cache duplication mode
191 DUNE_CACHE_TRANSPORT
193 Binary cache protocol
194 DUNE_DISABLE_PROMOTION
196 Disable all promotion rules
197 DUNE_PROFILE
199 Build profile. dev if unspecified or release if -p is set.
200 DUNE_SANDBOX
202 Sandboxing mode to use by default. (see --sandbox)
203 DUNE_STORE_ORIG_SOURCE_DIR
205 Store original source location in dune-package metadata
206 DUNE_WORKSPACE
208 Use this specific workspace file instead of looking it up.
209
211 Check bug reports at https://github.com/ocaml/dune/issues
212Dune n/a dune-upgrade(1)