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

NAME

6       dune-upgrade - Upgrade jbuilder projects to dune
7

SYNOPSIS

9       dune upgrade [OPTION]...
10

DESCRIPTION

12       dune upgrade upgrade all the jbuilder projects in the workspace to Dune
13

OPTIONS

15       --build-info
16           Show build information.
17
18       -f, --force
19           Force actions associated to aliases to be re-executed even if their
20           dependencies haven't changed.
21
22       --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
27       --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
32       --version
33           Show version information.
34
35       -w, --watch
36           Instead of terminating build after completion, wait continuously
37           for file changes.
38

COMMON OPTIONS

40       These options are common to all commands.
41
42       --always-show-command-line
43           Always show the full command lines of programs executed by dune
44
45       --auto-promote
46           Automatically promote files. This is similar to running dune
47           promote after the build.
48
49       --build-dir=FILE (absent DUNE_BUILD_DIR env)
50           Specified build directory. _build if unspecified
51
52       --cache=VAL (absent DUNE_CACHE env)
53           Activate binary cache (either `disabled' or `enabled'). Default is
54           `disabled'.
55
56       --cache-check-probability=VAL (absent=0. or
57       DUNE_CACHE_CHECK_PROBABILITY env)
58           Probability cached rules are rerun to check for reproducibility
59
60       --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
61           Binary cache duplication mode
62
63       --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
64           Binary cache protocol
65
66       --config-file=FILE
67           Load this configuration file instead of the default one.
68
69       --debug-artifact-substitution
70           Print debugging info about artifact substitution
71
72       --debug-backtraces
73           Always print exception backtraces.
74
75       --debug-dependency-path
76           In case of error, print the dependency path from the targets on the
77           command line to the rule that failed.
78
79       --debug-findlib
80           Debug the findlib sub-system.
81
82       --default-target=TARGET (absent=@@default)
83           Set the default target that when none is specified to dune build.
84
85       --diff-command=VAL
86           Shell command to use to diff files. Use - to disable printing the
87           diff.
88
89       --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
90           Disable all promotion rules
91
92       --display=MODE
93           Control the display mode of Dune. See dune-config(5) for more
94           details.
95
96       --ignore-promoted-rules
97           Ignore rules with (mode promote), except ones with (only ...). The
98           variable %{ignoring_promoted_rules} in dune files reflects whether
99           this option was passed or not.
100
101       --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
102           "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
103           list of library names, each one of which must declare an
104           instrumentation backend.
105
106       -j JOBS
107           Run no more than JOBS commands simultaneously.
108
109       --no-buffer
110           Do not buffer the output of commands executed by dune. By default
111           dune buffers the output of subcommands, in order to prevent
112           interleaving when multiple commands are executed in parallel.
113           However, this can be an issue when debugging long running tests.
114           With --no-buffer, commands have direct access to the terminal. Note
115           that as a result their output won't be captured in the log file.
116           You should use this option in conjunction with -j 1, to avoid
117           interleaving. Additionally you should use --verbose as well, to
118           make sure that commands are printed before they are being executed.
119
120       --no-config
121           Do not load the configuration file
122
123       --no-print-directory
124           Suppress "Entering directory" messages
125
126       --only-packages=PACKAGES
127           Ignore stanzas referring to a package that is not in PACKAGES.
128           PACKAGES is a comma-separated list of package names. Note that this
129           has the same effect as deleting the relevant stanzas from dune
130           files. It is mostly meant for releases. During development, it is
131           likely that what you want instead is to build a particular
132           <package>.install target.
133
134       -p PACKAGES, --for-release-of-packages=PACKAGES
135           Shorthand for --release --only-packages PACKAGE. You must use this
136           option in your <package>.opam files, in order to build only what's
137           necessary when your project contains multiple packages as well as
138           getting reproducible builds.
139
140       --profile=VAL (absent DUNE_PROFILE env)
141           Select the build profile, for instance dev or release. The default
142           is dev.
143
144       --promote-install-files
145           Promote the generated <package>.install files to the source tree
146
147       --release
148           Put dune into a reproducible release mode. This is in fact a
149           shorthand for --root . --ignore-promoted-rules --no-config
150           --profile release --always-show-command-line
151           --promote-install-files --default-target @install. You should use
152           this option for release builds. For instance, you must use this
153           option in your <package>.opam files. Except if you already use -p,
154           as -p implies this option.
155
156       --root=DIR
157           Use this directory as workspace root instead of guessing it. Note
158           that this option doesn't change the interpretation of targets given
159           on the command line. It is only intended for scripts.
160
161       --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
162           Store original source location in dune-package metadata
163
164       --terminal-persistence=MODE
165           Changes how the log of build results are displayed to the console
166           between rebuilds while in --watch mode. Supported modes: preserve,
167           clear-on-rebuild.
168
169       --trace-file=FILE
170           Output trace data in catapult format (compatible with
171           chrome://tracing)
172
173       --verbose
174           Same as --display verbose
175
176       --workspace=FILE (absent DUNE_WORKSPACE env)
177           Use this specific workspace file instead of looking it up.
178
179       -x VAL
180           Cross-compile using this toolchain.
181

MORE HELP

183       Use `dune COMMAND --help' for help on a single command.
184

ENVIRONMENT

186       These environment variables affect the execution of upgrade:
187
188       DUNE_BUILD_DIR
189           Specified build directory. _build if unspecified
190
191       DUNE_CACHE
192           Activate binary cache (either `disabled' or `enabled'). Default is
193           `disabled'.
194
195       DUNE_CACHE_CHECK_PROBABILITY
196           Probability cached rules are rerun to check for reproducibility
197
198       DUNE_CACHE_DUPLICATION
199           Binary cache duplication mode
200
201       DUNE_CACHE_TRANSPORT
202           Binary cache protocol
203
204       DUNE_DISABLE_PROMOTION
205           Disable all promotion rules
206
207       DUNE_INSTRUMENT_WITH
208           "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
209           list of library names, each one of which must declare an
210           instrumentation backend.
211
212       DUNE_PROFILE
213           Build profile. dev if unspecified or release if -p is set.
214
215       DUNE_SANDBOX
216           Sandboxing mode to use by default. (see --sandbox)
217
218       DUNE_STORE_ORIG_SOURCE_DIR
219           Store original source location in dune-package metadata
220
221       DUNE_WORKSPACE
222           Use this specific workspace file instead of looking it up.
223

BUGS

225       Check bug reports at https://github.com/ocaml/dune/issues
226
227
228
229Dune n/a                                                       DUNE-UPGRADE(1)
Impressum