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       --version
28           Show version information.
29
30       -w, --watch
31           Instead of terminating build after completion, wait continuously
32           for file changes.
33

COMMON OPTIONS

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

MORE HELP

140       Use `dune COMMAND --help' for help on a single command.
141

ENVIRONMENT

143       These environment variables affect the execution of upgrade:
144
145       DUNE_BUILD_DIR
146           Specified build directory. _build if unspecified
147
148       DUNE_PROFILE
149           Build profile. dev if unspecified or release if -p is set.
150
151       DUNE_STORE_ORIG_SOURCE_DIR
152           Store original source location in dune-package metadata
153
154       DUNE_WORKSPACE
155           Use this specific workspace file instead of looking it up.
156

BUGS

158       Check bug reports at https://github.com/ocaml/dune/issues
159
160
161
162Dune n/a                                                       dune-upgrade(1)