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       -f, --force
16           Force actions associated to aliases to be re-executed even if their
17           dependencies haven't changed.
18
19       --help[=FMT] (default=auto)
20           Show this help in format FMT. The value FMT must be one of `auto',
21           `pager', `groff' or `plain'. With `auto', the format is `pager` or
22           `plain' whenever the TERM env var is `dumb' or undefined.
23
24       --version
25           Show version information.
26
27       -w, --watch
28           Instead of terminating build after completion, wait continuously
29           for file changes.
30

COMMON OPTIONS

32       These options are common to all commands.
33
34       --auto-promote
35           Automatically promote files. This is similar to running dune
36           promote after the build.
37
38       --build-dir=FILE (absent DUNE_BUILD_DIR env)
39           Specified build directory. _build if unspecified
40
41       --config-file=FILE
42           Load this configuration file instead of the default one.
43
44       --debug-backtraces
45           Always print exception backtraces.
46
47       --debug-dependency-path
48           In case of error, print the dependency path from the targets on the
49           command line to the rule that failed.
50
51       --debug-findlib
52           Debug the findlib sub-system.
53
54       --default-target=TARGET
55           Set the default target that when none is specified to dune build.
56           It defaults to @@default.
57
58       --dev
59           Same as --profile dev
60
61       --diff-command=VAL
62           Shell command to use to diff files. Use - to disable printing the
63           diff.
64
65       --display=MODE
66           Control the display mode of Dune. See dune-config(5) for more
67           details.
68
69       --ignore-promoted-rules
70           Ignore rules with (mode promote)
71
72       -j JOBS
73           Run no more than JOBS commands simultaneously.
74
75       --no-buffer
76           Do not buffer the output of commands executed by dune. By default
77           dune buffers the output of subcommands, in order to prevent
78           interleaving when multiple commands are executed in parallel.
79           However, this can be an issue when debugging long running tests.
80           With --no-buffer, commands have direct access to the terminal. Note
81           that as a result their output won't be captured in the log file.
82           You should use this option in conjunction with -j 1, to avoid
83           interleaving. Additionally you should use --verbose as well, to
84           make sure that commands are printed before they are being executed.
85
86       --no-config
87           Do not load the configuration file
88
89       --no-print-directory
90           Suppress "Entering directory" messages
91
92       --only-packages=PACKAGES
93           Ignore stanzas referring to a package that is not in PACKAGES.
94           PACKAGES is a comma-separated list of package names. Note that this
95           has the same effect as deleting the relevant stanzas from jbuild
96           files. It is mostly meant for releases. During development, it is
97           likely that what you want instead is to build a particular
98           <package>.install target.
99
100       -p PACKAGES, --for-release-of-packages=PACKAGES
101           Shorthand for --root . --only-packages PACKAGE
102           --ignore-promoted-rules --no-config --profile release. You must use
103           this option in your <package>.opam files, in order to build only
104           what's necessary when your project contains multiple packages as
105           well as getting reproducible builds.
106
107       --profile=VAL (absent DUNE_PROFILE env)
108           Select the build profile, for instance dev or release. The default
109           is dev.
110
111       --root=DIR
112           Use this directory as workspace root instead of guessing it. Note
113           that this option doesn't change the interpretation of targets given
114           on the command line. It is only intended for scripts.
115
116       --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
117           Store original source location in dune-package metadata
118
119       --trace-file=FILE
120           Output trace data in catapult format (compatible with
121           chrome://tracing)
122
123       --verbose
124           Same as --display verbose
125
126       --workspace=FILE
127           Use this specific workspace file instead of looking it up.
128
129       -x VAL
130           Cross-compile using this toolchain.
131

MORE HELP

133       Use `dune COMMAND --help' for help on a single command.
134

ENVIRONMENT

136       These environment variables affect the execution of upgrade:
137
138       DUNE_BUILD_DIR
139           Specified build directory. _build if unspecified
140
141       DUNE_PROFILE
142           Build profile. dev if unspecified or release if -p is set.
143
144       DUNE_STORE_ORIG_SOURCE_DIR
145           Store original source location in dune-package metadata
146

BUGS

148       Check bug reports at https://github.com/ocaml/dune/issues
149
150
151
152Dune 11VERSION11                                               dune-upgrade(1)
Impressum