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