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 desciption is tied to the
23 version passed to --lang
24
26 --build-info
27 Show build information.
28 --context=CONTEXT (absent=default)
30 Build context to use.
31 -f, --force
33 Force actions associated to aliases to be re-executed even if their
34 dependencies haven't changed.
35 --format=FORMAT (absent=sexp)
37 Output format.
38 --help[=FMT] (default=auto)
40 Show this help in format FMT. The value FMT must be one of `auto',
41 `pager', `groff' or `plain'. With `auto', the format is `pager` or
42 `plain' whenever the TERM env var is `dumb' or undefined.
43 --lang=VERSION (absent=0.1)
45 Behave the same as this version of Dune.
46 --sandbox=VAL (absent DUNE_SANDBOX env)
48 Sandboxing mode to use by default. Some actions require a certain
49 sandboxing mode, so they will ignore this setting. The allowed
50 values are: none, symlink, copy.
51 --version
53 Show version information.
54 -w, --watch
56 Instead of terminating build after completion, wait continuously
57 for file changes.
58
60 These options are common to all commands.
61 --always-show-command-line
63 Always show the full command lines of programs executed by dune
64 --auto-promote
66 Automatically promote files. This is similar to running dune
67 promote after the build.
68 --build-dir=FILE (absent DUNE_BUILD_DIR env)
70 Specified build directory. _build if unspecified
71 --cache=VAL (absent DUNE_CACHE env)
73 Activate binary cache (either `disabled' or `enabled'). Default is
74 `disabled'.
75 --cache-check-probability=VAL (absent=0. or
77 DUNE_CACHE_CHECK_PROBABILITY env)
78 Probability cached rules are rerun to check for reproducibility
79 --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
81 Binary cache duplication mode
82 --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
84 Binary cache protocol
85 --config-file=FILE
87 Load this configuration file instead of the default one.
88 --debug-artifact-substitution
90 Print debugging info about artifact substitution
91 --debug-backtraces
93 Always print exception backtraces.
94 --debug-dependency-path
96 In case of error, print the dependency path from the targets on the
97 command line to the rule that failed.
98 --debug-findlib
100 Debug the findlib sub-system.
101 --default-target=TARGET (absent=@@default)
103 Set the default target that when none is specified to dune build.
104 --diff-command=VAL
106 Shell command to use to diff files. Use - to disable printing the
107 diff.
108 --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
110 Disable all promotion rules
111 --display=MODE
113 Control the display mode of Dune. See dune-config(5) for more
114 details.
115 --ignore-promoted-rules
117 Ignore rules with (mode promote), except ones with (only ...). The
118 variable %{ignoring_promoted_rules} in dune files reflects whether
119 this option was passed or not.
120 --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env)
122 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
123 list of library names, each one of which must declare an
124 instrumentation backend.
125 -j JOBS
127 Run no more than JOBS commands simultaneously.
128 --no-buffer
130 Do not buffer the output of commands executed by dune. By default
131 dune buffers the output of subcommands, in order to prevent
132 interleaving when multiple commands are executed in parallel.
133 However, this can be an issue when debugging long running tests.
134 With --no-buffer, commands have direct access to the terminal. Note
135 that as a result their output won't be captured in the log file.
136 You should use this option in conjunction with -j 1, to avoid
137 interleaving. Additionally you should use --verbose as well, to
138 make sure that commands are printed before they are being executed.
139 --no-config
141 Do not load the configuration file
142 --no-print-directory
144 Suppress "Entering directory" messages
145 --only-packages=PACKAGES
147 Ignore stanzas referring to a package that is not in PACKAGES.
148 PACKAGES is a comma-separated list of package names. Note that this
149 has the same effect as deleting the relevant stanzas from dune
150 files. It is mostly meant for releases. During development, it is
151 likely that what you want instead is to build a particular
152 <package>.install target.
153 -p PACKAGES, --for-release-of-packages=PACKAGES
155 Shorthand for --release --only-packages PACKAGE. You must use this
156 option in your <package>.opam files, in order to build only what's
157 necessary when your project contains multiple packages as well as
158 getting reproducible builds.
159 --profile=VAL (absent DUNE_PROFILE env)
161 Select the build profile, for instance dev or release. The default
162 is dev.
163 --promote-install-files
165 Promote the generated <package>.install files to the source tree
166 --release
168 Put dune into a reproducible release mode. This is in fact a
169 shorthand for --root . --ignore-promoted-rules --no-config
170 --profile release --always-show-command-line
171 --promote-install-files --default-target @install. You should use
172 this option for release builds. For instance, you must use this
173 option in your <package>.opam files. Except if you already use -p,
174 as -p implies this option.
175 --root=DIR
177 Use this directory as workspace root instead of guessing it. Note
178 that this option doesn't change the interpretation of targets given
179 on the command line. It is only intended for scripts.
180 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
182 Store original source location in dune-package metadata
183 --terminal-persistence=MODE
185 Changes how the log of build results are displayed to the console
186 between rebuilds while in --watch mode.
187 --trace-file=FILE
189 Output trace data in catapult format (compatible with
190 chrome://tracing)
191 --verbose
193 Same as --display verbose
194 --workspace=FILE (absent DUNE_WORKSPACE env)
196 Use this specific workspace file instead of looking it up.
197 -x VAL
199 Cross-compile using this toolchain.
200
202 Use `dune COMMAND --help' for help on a single command.
203
205 These environment variables affect the execution of describe:
206 DUNE_BUILD_DIR
208 Specified build directory. _build if unspecified
209 DUNE_CACHE
211 Activate binary cache (either `disabled' or `enabled'). Default is
212 `disabled'.
213 DUNE_CACHE_CHECK_PROBABILITY
215 Probability cached rules are rerun to check for reproducibility
216 DUNE_CACHE_DUPLICATION
218 Binary cache duplication mode
219 DUNE_CACHE_TRANSPORT
221 Binary cache protocol
222 DUNE_DISABLE_PROMOTION
224 Disable all promotion rules
225 DUNE_INSTRUMENT_WITH
227 "Enable instrumentation by BACKENDS. BACKENDS is a comma-separated
228 list of library names, each one of which must declare an
229 instrumentation backend.
230 DUNE_PROFILE
232 Build profile. dev if unspecified or release if -p is set.
233 DUNE_SANDBOX
235 Sandboxing mode to use by default. (see --sandbox)
236 DUNE_STORE_ORIG_SOURCE_DIR
238 Store original source location in dune-package metadata
239 DUNE_WORKSPACE
241 Use this specific workspace file instead of looking it up.
242
244 Check bug reports at https://github.com/ocaml/dune/issues
245Dune n/a dune-describe(1)