1DUNE-PROMOTE(1) Dune Manual DUNE-PROMOTE(1)
2
6 dune-promote - Promote files from the last run
7
9 dune promote [OPTION]... [FILE]...
10
12 Considering all actions of the form (diff a b) that failed in the last
13 run of dune, dune promote does the following: If a is present in the
14 source tree but b isn't, b is copied over to a in the source tree. The
15 idea behind this is that you might use (diff file.expected
16 file.generated) and then call dune promote to promote the generated
17 file.
18
20 --build-info
21 Show build information.
22 -f, --force
24 Force actions associated to aliases to be re-executed even if their
25 dependencies haven't changed.
26 --help[=FMT] (default=auto)
28 Show this help in format FMT. The value FMT must be one of `auto',
29 `pager', `groff' or `plain'. With `auto', the format is `pager` or
30 `plain' whenever the TERM env var is `dumb' or undefined.
31 --sandbox=VAL (absent DUNE_SANDBOX env)
33 Sandboxing mode to use by default. Some actions require a certain
34 sandboxing mode, so they will ignore this setting. The allowed
35 values are: none, symlink, copy.
36 --version
38 Show version information.
39 -w, --watch
41 Instead of terminating build after completion, wait continuously
42 for file changes.
43
45 These options are common to all commands.
46 --always-show-command-line
48 Always show the full command lines of programs executed by dune
49 --auto-promote
51 Automatically promote files. This is similar to running dune
52 promote after the build.
53 --build-dir=FILE (absent DUNE_BUILD_DIR env)
55 Specified build directory. _build if unspecified
56 --cache=VAL (absent DUNE_CACHE env)
58 Activate binary cache (either `disabled' or `enabled'). Default is
59 `disabled'.
60 --cache-check-probability=VAL (absent=0. or
62 DUNE_CACHE_CHECK_PROBABILITY env)
63 Probability cached rules are rerun to check for reproducibility
64 --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
66 Binary cache duplication mode
67 --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
69 Binary cache protocol
70 --config-file=FILE
72 Load this configuration file instead of the default one.
73 --debug-artifact-substitution
75 Print debugging info about artifact substitution
76 --debug-backtraces
78 Always print exception backtraces.
79 --debug-dependency-path
81 In case of error, print the dependency path from the targets on the
82 command line to the rule that failed.
83 --debug-findlib
85 Debug the findlib sub-system.
86 --default-target=TARGET (absent=@@default)
88 Set the default target that when none is specified to dune build.
89 --diff-command=VAL
91 Shell command to use to diff files. Use - to disable printing the
92 diff.
93 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
95 Disable all promotion rules
96 --display=MODE
98 Control the display mode of Dune. See dune-config(5) for more
99 details.
100 --ignore-promoted-rules
102 Ignore rules with (mode promote), except ones with (only ...). The
103 variable %{ignoring_promoted_rules} in dune files reflects whether
104 this option was passed or not.
105 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
107 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
108 list of library names, each one of which must declare an
109 instrumentation backend.
110 -j JOBS
112 Run no more than JOBS commands simultaneously.
113 --no-buffer
115 Do not buffer the output of commands executed by dune. By default
116 dune buffers the output of subcommands, in order to prevent
117 interleaving when multiple commands are executed in parallel.
118 However, this can be an issue when debugging long running tests.
119 With --no-buffer, commands have direct access to the terminal. Note
120 that as a result their output won't be captured in the log file.
121 You should use this option in conjunction with -j 1, to avoid
122 interleaving. Additionally you should use --verbose as well, to
123 make sure that commands are printed before they are being executed.
124 --no-config
126 Do not load the configuration file
127 --no-print-directory
129 Suppress "Entering directory" messages
130 --only-packages=PACKAGES
132 Ignore stanzas referring to a package that is not in PACKAGES.
133 PACKAGES is a comma-separated list of package names. Note that this
134 has the same effect as deleting the relevant stanzas from dune
135 files. It is mostly meant for releases. During development, it is
136 likely that what you want instead is to build a particular
137 <package>.install target.
138 -p PACKAGES, --for-release-of-packages=PACKAGES (required)
140 Shorthand for --release --only-packages PACKAGE. You must use this
141 option in your <package>.opam files, in order to build only what's
142 necessary when your project contains multiple packages as well as
143 getting reproducible builds.
144 --profile=VAL (absent DUNE_PROFILE env)
146 Select the build profile, for instance dev or release. The default
147 is dev.
148 --promote-install-files[=VAL] (default=true)
150 Promote the generated <package>.install files to the source tree
151 --release
153 Put dune into a reproducible release mode. This is in fact a
154 shorthand for --root . --ignore-promoted-rules --no-config
155 --profile release --always-show-command-line
156 --promote-install-files --default-target @install. You should use
157 this option for release builds. For instance, you must use this
158 option in your <package>.opam files. Except if you already use -p,
159 as -p implies this option.
160 --root=DIR
162 Use this directory as workspace root instead of guessing it. Note
163 that this option doesn't change the interpretation of targets given
164 on the command line. It is only intended for scripts.
165 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
167 Store original source location in dune-package metadata
168 --terminal-persistence=MODE
170 Changes how the log of build results are displayed to the console
171 between rebuilds while in --watch mode. Supported modes: preserve,
172 clear-on-rebuild.
173 --trace-file=FILE
175 Output trace data in catapult format (compatible with
176 chrome://tracing)
177 --verbose
179 Same as --display verbose
180 --workspace=FILE (absent DUNE_WORKSPACE env)
182 Use this specific workspace file instead of looking it up.
183 -x VAL
185 Cross-compile using this toolchain.
186
188 Use `dune COMMAND --help' for help on a single command.
189
191 These environment variables affect the execution of promote:
192 DUNE_BUILD_DIR
194 Specified build directory. _build if unspecified
195 DUNE_CACHE
197 Activate binary cache (either `disabled' or `enabled'). Default is
198 `disabled'.
199 DUNE_CACHE_CHECK_PROBABILITY
201 Probability cached rules are rerun to check for reproducibility
202 DUNE_CACHE_DUPLICATION
204 Binary cache duplication mode
205 DUNE_CACHE_TRANSPORT
207 Binary cache protocol
208 DUNE_DISABLE_PROMOTION
210 Disable all promotion rules
211 DUNE_INSTRUMENT_WITH
213 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
214 list of library names, each one of which must declare an
215 instrumentation backend.
216 DUNE_PROFILE
218 Build profile. dev if unspecified or release if -p is set.
219 DUNE_SANDBOX
221 Sandboxing mode to use by default. (see --sandbox)
222 DUNE_STORE_ORIG_SOURCE_DIR
224 Store original source location in dune-package metadata
225 DUNE_WORKSPACE
227 Use this specific workspace file instead of looking it up.
228
230 Check bug reports at https://github.com/ocaml/dune/issues
231Dune n/a DUNE-PROMOTE(1)