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-backtraces
75 Always print exception backtraces.
76 --debug-dependency-path
78 In case of error, print the dependency path from the targets on the
79 command line to the rule that failed.
80 --debug-findlib
82 Debug the findlib sub-system.
83 --default-target=TARGET (absent=@@default)
85 Set the default target that when none is specified to dune build.
86 --diff-command=VAL
88 Shell command to use to diff files. Use - to disable printing the
89 diff.
90 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
92 Disable all promotion rules
93 --display=MODE
95 Control the display mode of Dune. See dune-config(5) for more
96 details.
97 --ignore-promoted-rules
99 Ignore rules with (mode promote), except ones with (only ...). The
100 variable %{ignoring_promoted_rules} in dune files reflects whether
101 this option was passed or not.
102 -j JOBS
104 Run no more than JOBS commands simultaneously.
105 --no-buffer
107 Do not buffer the output of commands executed by dune. By default
108 dune buffers the output of subcommands, in order to prevent
109 interleaving when multiple commands are executed in parallel.
110 However, this can be an issue when debugging long running tests.
111 With --no-buffer, commands have direct access to the terminal. Note
112 that as a result their output won't be captured in the log file.
113 You should use this option in conjunction with -j 1, to avoid
114 interleaving. Additionally you should use --verbose as well, to
115 make sure that commands are printed before they are being executed.
116 --no-config
118 Do not load the configuration file
119 --no-print-directory
121 Suppress "Entering directory" messages
122 --only-packages=PACKAGES
124 Ignore stanzas referring to a package that is not in PACKAGES.
125 PACKAGES is a comma-separated list of package names. Note that this
126 has the same effect as deleting the relevant stanzas from dune
127 files. It is mostly meant for releases. During development, it is
128 likely that what you want instead is to build a particular
129 <package>.install target.
130 -p PACKAGES, --for-release-of-packages=PACKAGES
132 Shorthand for --release --only-packages PACKAGE. You must use this
133 option in your <package>.opam files, in order to build only what's
134 necessary when your project contains multiple packages as well as
135 getting reproducible builds.
136 --profile=VAL (absent DUNE_PROFILE env)
138 Select the build profile, for instance dev or release. The default
139 is dev.
140 --promote-install-files
142 Promote the generated <package>.install files to the source tree
143 --release
145 Put dune into a reproducible release mode. This is in fact a
146 shorthand for --root . --ignore-promoted-rules --no-config
147 --profile release --always-show-command-line
148 --promote-install-files --default-target @install. You should use
149 this option for release builds. For instance, you must use this
150 option in your <package>.opam files. Except if you already use -p,
151 as -p implies this option.
152 --root=DIR
154 Use this directory as workspace root instead of guessing it. Note
155 that this option doesn't change the interpretation of targets given
156 on the command line. It is only intended for scripts.
157 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
159 Store original source location in dune-package metadata
160 --terminal-persistence=MODE
162 Changes how the log of build results are displayed to the console
163 between rebuilds while in --watch mode.
164 --trace-file=FILE
166 Output trace data in catapult format (compatible with
167 chrome://tracing)
168 --verbose
170 Same as --display verbose
171 --workspace=FILE (absent DUNE_WORKSPACE env)
173 Use this specific workspace file instead of looking it up.
174 -x VAL
176 Cross-compile using this toolchain.
177
179 Use `dune COMMAND --help' for help on a single command.
180
182 These environment variables affect the execution of promote:
183 DUNE_BUILD_DIR
185 Specified build directory. _build if unspecified
186 DUNE_CACHE
188 Activate binary cache (either `disabled' or `enabled'). Default is
189 `disabled'.
190 DUNE_CACHE_CHECK_PROBABILITY
192 Probability cached rules are rerun to check for reproducibility
193 DUNE_CACHE_DUPLICATION
195 Binary cache duplication mode
196 DUNE_CACHE_TRANSPORT
198 Binary cache protocol
199 DUNE_DISABLE_PROMOTION
201 Disable all promotion rules
202 DUNE_PROFILE
204 Build profile. dev if unspecified or release if -p is set.
205 DUNE_SANDBOX
207 Sandboxing mode to use by default. (see --sandbox)
208 DUNE_STORE_ORIG_SOURCE_DIR
210 Store original source location in dune-package metadata
211 DUNE_WORKSPACE
213 Use this specific workspace file instead of looking it up.
214
216 Check bug reports at https://github.com/ocaml/dune/issues
217Dune n/a dune-promote(1)