1DUNE-DESCRIBE(1) Dune Manual DUNE-DESCRIBE(1)
2
6 dune-describe - Describe the workspace.
7
9 dune describe [OPTION]… [STRING]…
10
12 Describe what is in the current workspace in either human or machine
13 readable form. By default, this command output a human readable
14 description of the current workspace. This output is aimed at human and
15 is not suitable for machine processing. In particular, it is not
16 versioned. If you want to interpret the output of this command from a
17 program, you must use the --format option to specify a machine readable
18 format as well as the --lang option to get a stable output.
19
21 STRING
22 What to describe. The syntax of this description is tied to the
23 version passed to --lang. The currently available commands are the
24 following: workspace DIRS (prints a description of the workspace's
25 structure. If some directories DIRS are provided, then only those
26 directories of the workspace are considered.), opam-files (prints
27 information about the Opam files that have been discovered), pp
28 FILE (builds a given FILE and prints the preprocessed output),
29 external-lib-deps (Print out external libraries needed to build the
30 project. It's an approximated set of libraries.).
31
33 --action-stderr-on-success=VAL
34 Same as --action-stdout-on-success but for the standard output for
35 error messages. A good default for large mono-repositories is
36 --action-stdout-on-success=swallow
37 --action-stderr-on-success=must-be-empty. This ensures that a
38 successful build has a "clean" empty output.
39 --action-stdout-on-success=VAL
41 Specify how to deal with the standard output of actions when they
42 succeed. Possible values are: print to just print it to Dune's
43 output, swallow to completely ignore it and must-be-empty to
44 enforce that the action printed nothing. With must-be-empty, Dune
45 will consider that the action failed if it printed something to its
46 standard output. The default is print.
47 --build-info
49 Show build information.
50 --context=CONTEXT (absent=default)
52 Build context to use.
53 --error-reporting=VAL (absent=deterministic)
55 Controls when the build errors are reported. early - report errors
56 as soon as they are discovered. deterministic - report errors at
57 the end of the build in a deterministic order. twice - report each
58 error twice: once as soon as the error is discovered and then again
59 at the end of the build, in a deterministic order.
60 -f, --force
62 Force actions associated to aliases to be re-executed even if their
63 dependencies haven't changed.
64 --file-watcher=VAL (absent=automatic)
66 Mechanism to detect changes in the source. Automatic to make dune
67 run an external program to detect changes. Manual to notify dune
68 that files have changed manually."
69 --format=FORMAT (absent=sexp)
71 FORMAT must be either sexp or csexp
72 --lang=VERSION (absent=0.1)
74 Behave the same as this version of Dune.
75 --passive-watch-mode
77 Similar to [--watch], but only start a build when instructed
78 externally by an RPC.
79 --react-to-insignificant-changes
81 react to insignificant file system changes; this is only useful for
82 benchmarking dune
83 --sandbox=VAL (absent DUNE_SANDBOX env)
85 Sandboxing mode to use by default. Some actions require a certain
86 sandboxing mode, so they will ignore this setting. The allowed
87 values are: none, symlink, copy, hardlink.
88 --sanitize-for-tests
90 Sanitize the absolute paths in workspace items, and the associated
91 UIDs, so that the output is reproducible. For use in dune's
92 internal tests only (for the workspace command only).
93 -w, --watch
95 Instead of terminating build after completion, wait continuously
96 for file changes.
97 --wait-for-filesystem-clock
99 Dune digest file contents for better incrementally. These digests
100 are themselves cached. In some cases, Dune needs to drop some
101 digest cache entries in order for things to be reliable. This
102 option makes Dune wait for the file system clock to advance so that
103 it doesn't need to drop anything. You should probably not care
104 about this option; it is mostly useful for Dune developers to make
105 Dune tests of the digest cache more reproducible.
106 --with-deps
108 Whether the dependencies between modules should be printed (for the
109 workspace command only).
110
112 These options are common to all commands.
113 --always-show-command-line
115 Always show the full command lines of programs executed by dune
116 --auto-promote
118 Automatically promote files. This is similar to running dune
119 promote after the build.
120 --build-dir=FILE (absent DUNE_BUILD_DIR env)
122 Specified build directory. _build if unspecified
123 --cache=VAL (absent DUNE_CACHE env)
125 Enable or disable Dune cache (either enabled or disabled). Default
126 is `disabled'.
127 --cache-check-probability=VAL (absent DUNE_CACHE_CHECK_PROBABILITY env)
129 Check build reproducibility by re-executing randomly chosen rules
130 and comparing their results with those stored in Dune cache. Note:
131 by increasing the probability of such checks you slow down the
132 build. The default probability is zero, i.e. no rules are checked.
133 --cache-storage-mode=VAL (absent DUNE_CACHE_STORAGE_MODE env)
135 Dune cache storage mode (one of auto, hardlink or copy). Default is
136 `auto'.
137 --config-file=FILE
139 Load this configuration file instead of the default one.
140 --debug-artifact-substitution
142 Print debugging info about artifact substitution
143 --debug-backtraces
145 Always print exception backtraces.
146 --debug-cache=VAL
148 Show debug messages on cache misses for the given cache layers.
149 Value is a comma-separated list of cache layer names. All available
150 cache layers: shared,workspace-local,fs.
151 --debug-dependency-path
153 In case of error, print the dependency path from the targets on the
154 command line to the rule that failed.
155 --debug-digests
157 Explain why Dune decides to re-digest some files
158 --debug-findlib
160 Debug the findlib sub-system.
161 --debug-load-dir
163 Print debugging info about directory loading
164 --debug-store-digest-preimage
166 Store digest preimage for all computed digests, so that it's
167 possible to reverse them later, for debugging. The digests are
168 stored in the shared cache (see --cache flag) as values, even if
169 cache is otherwise disabled. This should be used only for
170 debugging, since it's slow and it litters the shared cache.
171 --default-target=TARGET (absent=@@default)
173 Set the default target that when none is specified to dune build.
174 --diff-command=VAL (absent DUNE_DIFF_COMMAND env)
176 Shell command to use to diff files. Use - to disable printing the
177 diff.
178 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
180 Disable all promotion rules
181 --display=MODE
183 Control the display mode of Dune. See dune-config(5) for more
184 details.
185 --dump-memo-graph=FILE
187 Dumps the dependency graph to a file after the build is complete
188 --dump-memo-graph-format=FORMAT (absent=gexf)
190 File format to be used when dumping dependency graph
191 --dump-memo-graph-with-timing
193 With --dump-memo-graph, will re-run each cached node in the Memo
194 graph after building and include the runtime in the output. Since
195 all nodes contain a cached value, this will measure just the
196 runtime of each node
197 --help[=FMT] (default=auto)
199 Show this help in format FMT. The value FMT must be one of auto,
200 pager, groff or plain. With auto, the format is pager or plain
201 whenever the TERM env var is dumb or undefined.
202 --ignore-promoted-rules
204 Ignore rules with (mode promote), except ones with (only ...). The
205 variable %{ignoring_promoted_rules} in dune files reflects whether
206 this option was passed or not.
207 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
209 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
210 list of library names, each one of which must declare an
211 instrumentation backend.
212 -j JOBS
214 Run no more than JOBS commands simultaneously.
215 --no-buffer
217 Do not buffer the output of commands executed by dune. By default
218 dune buffers the output of subcommands, in order to prevent
219 interleaving when multiple commands are executed in parallel.
220 However, this can be an issue when debugging long running tests.
221 With --no-buffer, commands have direct access to the terminal. Note
222 that as a result their output won't be captured in the log file.
223 You should use this option in conjunction with -j 1, to avoid
224 interleaving. Additionally you should use --verbose as well, to
225 make sure that commands are printed before they are being executed.
226 --no-config
228 Do not load the configuration file
229 --no-print-directory
231 Suppress "Entering directory" messages
232 --only-packages=PACKAGES
234 Ignore stanzas referring to a package that is not in PACKAGES.
235 PACKAGES is a comma-separated list of package names. Note that this
236 has the same effect as deleting the relevant stanzas from dune
237 files. It is mostly meant for releases. During development, it is
238 likely that what you want instead is to build a particular
239 <package>.install target.
240 -p PACKAGES, --for-release-of-packages=PACKAGES (required)
242 Shorthand for --release --only-packages PACKAGE. You must use this
243 option in your <package>.opam files, in order to build only what's
244 necessary when your project contains multiple packages as well as
245 getting reproducible builds.
246 --print-metrics
248 Print out various performance metrics after every build
249 --profile=VAL (absent DUNE_PROFILE env)
251 Select the build profile, for instance dev or release. The default
252 is dev.
253 --promote-install-files[=VAL] (default=true)
255 Promote the generated <package>.install files to the source tree
256 --release
258 Put dune into a reproducible release mode. This is in fact a
259 shorthand for --root . --ignore-promoted-rules --no-config
260 --profile release --always-show-command-line
261 --promote-install-files --default-target @install
262 --require-dune-project-file. You should use this option for release
263 builds. For instance, you must use this option in your
264 <package>.opam files. Except if you already use -p, as -p implies
265 this option.
266 --require-dune-project-file[=VAL] (default=true)
268 Fail if a dune-project file is missing.
269 --root=DIR
271 Use this directory as workspace root instead of guessing it. Note
272 that this option doesn't change the interpretation of targets given
273 on the command line. It is only intended for scripts.
274 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
276 Store original source location in dune-package metadata
277 --terminal-persistence=MODE
279 Changes how the log of build results are displayed to the console
280 between rebuilds while in --watch mode. Supported modes: preserve,
281 clear-on-rebuild, clear-on-rebuild-and-flush-history.
282 --trace-file=FILE
284 Output trace data in catapult format (compatible with
285 chrome://tracing)
286 --verbose
288 Same as --display verbose
289 --version
291 Show version information.
292 --workspace=FILE (absent DUNE_WORKSPACE env)
294 Use this specific workspace file instead of looking it up.
295 -x VAL
297 Cross-compile using this toolchain.
298
300 Use `dune COMMAND --help' for help on a single command.
301
303 describe exits with the following status:
304 0 on success.
306 123 on indiscriminate errors reported on standard error.
308 124 on command line parsing errors.
310 125 on unexpected internal errors (bugs).
312
314 These environment variables affect the execution of describe:
315 DUNE_BUILD_DIR
317 Specified build directory. _build if unspecified
318 DUNE_CACHE
320 Enable or disable Dune cache (either enabled or disabled). Default
321 is `disabled'.
322 DUNE_CACHE_CHECK_PROBABILITY
324 Check build reproducibility by re-executing randomly chosen rules
325 and comparing their results with those stored in Dune cache. Note:
326 by increasing the probability of such checks you slow down the
327 build. The default probability is zero, i.e. no rules are checked.
328 DUNE_CACHE_STORAGE_MODE
330 Dune cache storage mode (one of auto, hardlink or copy). Default is
331 `auto'.
332 DUNE_DIFF_COMMAND
334 Shell command to use to diff files. Use - to disable printing the
335 diff.
336 DUNE_DISABLE_PROMOTION
338 Disable all promotion rules
339 DUNE_INSTRUMENT_WITH
341 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
342 list of library names, each one of which must declare an
343 instrumentation backend.
344 DUNE_PROFILE
346 Build profile. dev if unspecified or release if -p is set.
347 DUNE_SANDBOX
349 Sandboxing mode to use by default. (see --sandbox)
350 DUNE_STORE_ORIG_SOURCE_DIR
352 Store original source location in dune-package metadata
353 DUNE_WORKSPACE
355 Use this specific workspace file instead of looking it up.
356
358 Check bug reports at https://github.com/ocaml/dune/issues
359
361 dune(1)
362Dune n/a DUNE-DESCRIBE(1)