1dune-compute(1)                   Dune Manual                  dune-compute(1)
2
3
4

NAME

6       dune-compute - Compute internal function.
7

SYNOPSIS

9       dune compute [OPTION]... FUNCTION [INPUT]
10

DESCRIPTION

12       Run a registered memoize function with the given input and print the
13       output.
14
15       This should only be used for debugging dune.
16

ARGUMENTS

18       FUNCTION (required)
19           Compute FUNCTION for a given input.
20
21       INPUT
22           Use INPUT as the input to the function.
23

OPTIONS

25       --build-info
26           Show build information.
27
28       -f, --force
29           Force actions associated to aliases to be re-executed even if their
30           dependencies haven't changed.
31
32       --help[=FMT] (default=auto)
33           Show this help in format FMT. The value FMT must be one of `auto',
34           `pager', `groff' or `plain'. With `auto', the format is `pager` or
35           `plain' whenever the TERM env var is `dumb' or undefined.
36
37       --sandbox=VAL (absent DUNE_SANDBOX env)
38           Sandboxing mode to use by default. Some actions require a certain
39           sandboxing mode, so they will ignore this setting. The allowed
40           values are: none, symlink, copy.
41
42       --version
43           Show version information.
44
45       -w, --watch
46           Instead of terminating build after completion, wait continuously
47           for file changes.
48

COMMON OPTIONS

50       These options are common to all commands.
51
52       --always-show-command-line
53           Always show the full command lines of programs executed by dune
54
55       --auto-promote
56           Automatically promote files. This is similar to running dune
57           promote after the build.
58
59       --build-dir=FILE (absent DUNE_BUILD_DIR env)
60           Specified build directory. _build if unspecified
61
62       --cache=VAL (absent DUNE_CACHE env)
63           Activate binary cache (either `disabled' or `enabled'). Default is
64           `disabled'.
65
66       --cache-check-probability=VAL (absent=0. or
67       DUNE_CACHE_CHECK_PROBABILITY env)
68           Probability cached rules are rerun to check for reproducibility
69
70       --cache-duplication=VAL (absent DUNE_CACHE_DUPLICATION env)
71           Binary cache duplication mode
72
73       --cache-transport=VAL (absent DUNE_CACHE_TRANSPORT env)
74           Binary cache protocol
75
76       --config-file=FILE
77           Load this configuration file instead of the default one.
78
79       --debug-backtraces
80           Always print exception backtraces.
81
82       --debug-dependency-path
83           In case of error, print the dependency path from the targets on the
84           command line to the rule that failed.
85
86       --debug-findlib
87           Debug the findlib sub-system.
88
89       --default-target=TARGET (absent=@@default)
90           Set the default target that when none is specified to dune build.
91
92       --diff-command=VAL
93           Shell command to use to diff files. Use - to disable printing the
94           diff.
95
96       --disable-promotion (absent DUNE_DISABLE_PROMOTION env)
97           Disable all promotion rules
98
99       --display=MODE
100           Control the display mode of Dune. See dune-config(5) for more
101           details.
102
103       --ignore-promoted-rules
104           Ignore rules with (mode promote), except ones with (only ...). The
105           variable %{ignoring_promoted_rules} in dune files reflects whether
106           this option was passed or not.
107
108       -j JOBS
109           Run no more than JOBS commands simultaneously.
110
111       --no-buffer
112           Do not buffer the output of commands executed by dune. By default
113           dune buffers the output of subcommands, in order to prevent
114           interleaving when multiple commands are executed in parallel.
115           However, this can be an issue when debugging long running tests.
116           With --no-buffer, commands have direct access to the terminal. Note
117           that as a result their output won't be captured in the log file.
118           You should use this option in conjunction with -j 1, to avoid
119           interleaving. Additionally you should use --verbose as well, to
120           make sure that commands are printed before they are being executed.
121
122       --no-config
123           Do not load the configuration file
124
125       --no-print-directory
126           Suppress "Entering directory" messages
127
128       --only-packages=PACKAGES
129           Ignore stanzas referring to a package that is not in PACKAGES.
130           PACKAGES is a comma-separated list of package names. Note that this
131           has the same effect as deleting the relevant stanzas from dune
132           files. It is mostly meant for releases. During development, it is
133           likely that what you want instead is to build a particular
134           <package>.install target.
135
136       -p PACKAGES, --for-release-of-packages=PACKAGES
137           Shorthand for --release --only-packages PACKAGE. You must use this
138           option in your <package>.opam files, in order to build only what's
139           necessary when your project contains multiple packages as well as
140           getting reproducible builds.
141
142       --profile=VAL (absent DUNE_PROFILE env)
143           Select the build profile, for instance dev or release. The default
144           is dev.
145
146       --promote-install-files
147           Promote the generated <package>.install files to the source tree
148
149       --release
150           Put dune into a reproducible release mode. This is in fact a
151           shorthand for --root . --ignore-promoted-rules --no-config
152           --profile release --always-show-command-line
153           --promote-install-files --default-target @install. You should use
154           this option for release builds. For instance, you must use this
155           option in your <package>.opam files. Except if you already use -p,
156           as -p implies this option.
157
158       --root=DIR
159           Use this directory as workspace root instead of guessing it. Note
160           that this option doesn't change the interpretation of targets given
161           on the command line. It is only intended for scripts.
162
163       --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
164           Store original source location in dune-package metadata
165
166       --terminal-persistence=MODE
167            Changes how the log of build results are displayed to the console
168           between rebuilds while in --watch mode.
169
170       --trace-file=FILE
171           Output trace data in catapult format (compatible with
172           chrome://tracing)
173
174       --verbose
175           Same as --display verbose
176
177       --workspace=FILE (absent DUNE_WORKSPACE env)
178           Use this specific workspace file instead of looking it up.
179
180       -x VAL
181           Cross-compile using this toolchain.
182

MORE HELP

184       Use `dune COMMAND --help' for help on a single command.
185

ENVIRONMENT

187       These environment variables affect the execution of compute:
188
189       DUNE_BUILD_DIR
190           Specified build directory. _build if unspecified
191
192       DUNE_CACHE
193           Activate binary cache (either `disabled' or `enabled'). Default is
194           `disabled'.
195
196       DUNE_CACHE_CHECK_PROBABILITY
197           Probability cached rules are rerun to check for reproducibility
198
199       DUNE_CACHE_DUPLICATION
200           Binary cache duplication mode
201
202       DUNE_CACHE_TRANSPORT
203           Binary cache protocol
204
205       DUNE_DISABLE_PROMOTION
206           Disable all promotion rules
207
208       DUNE_PROFILE
209           Build profile. dev if unspecified or release if -p is set.
210
211       DUNE_SANDBOX
212           Sandboxing mode to use by default. (see --sandbox)
213
214       DUNE_STORE_ORIG_SOURCE_DIR
215           Store original source location in dune-package metadata
216
217       DUNE_WORKSPACE
218           Use this specific workspace file instead of looking it up.
219

BUGS

221       Check bug reports at https://github.com/ocaml/dune/issues
222
223
224
225Dune n/a                                                       dune-compute(1)
Impressum