1dune-rules(1) Dune Manual dune-rules(1)
2
6 dune-rules - Dump internal rules.
7
9 dune rules [OPTION]... [TARGET]...
10
12 Dump Dune internal rules for the given targets. If no targets are
13 given, dump all the internal rules.
14 By default the output is a list of S-expressions, one S-expression per
16 rule. Each S-expression is of the form:
17 ((deps (<dependencies>))
19 (targets (<targets>))
20 (context <context-name>)
21 (action <action>))
22 <context-name> is the context is which the action is executed. It is
24 omitted if the action is independent from the context.
25 <action> is the action following the same syntax as user actions, as
27 described in the manual.
28
30 --build-info
31 Show build information.
32 -f, --force
34 Force actions associated to aliases to be re-executed even if their
35 dependencies haven't changed.
36 --help[=FMT] (default=auto)
38 Show this help in format FMT. The value FMT must be one of `auto',
39 `pager', `groff' or `plain'. With `auto', the format is `pager` or
40 `plain' whenever the TERM env var is `dumb' or undefined.
41 -m, --makefile
43 Output the rules in Makefile syntax.
44 -o FILE
46 Output to a file instead of stdout.
47 -r, --recursive
49 Print all rules needed to build the transitive dependencies of the
50 given targets.
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 --config-file=FILE
73 Load this configuration file instead of the default one.
74 --debug-backtraces
76 Always print exception backtraces.
77 --debug-dependency-path
79 In case of error, print the dependency path from the targets on the
80 command line to the rule that failed.
81 --debug-findlib
83 Debug the findlib sub-system.
84 --default-target=TARGET (absent=@@default)
86 Set the default target that when none is specified to dune build.
87 --dev
89 Same as --profile dev
90 --diff-command=VAL
92 Shell command to use to diff files. Use - to disable printing the
93 diff.
94 --display=MODE
96 Control the display mode of Dune. See dune-config(5) for more
97 details.
98 --ignore-promoted-rules
100 Ignore rules with (mode promote), except ones with (only ...). The
101 variable %{ignoring_promoted_rules} in dune files reflects whether
102 this option was passed or not.
103 -j JOBS
105 Run no more than JOBS commands simultaneously.
106 --no-buffer
108 Do not buffer the output of commands executed by dune. By default
109 dune buffers the output of subcommands, in order to prevent
110 interleaving when multiple commands are executed in parallel.
111 However, this can be an issue when debugging long running tests.
112 With --no-buffer, commands have direct access to the terminal. Note
113 that as a result their output won't be captured in the log file.
114 You should use this option in conjunction with -j 1, to avoid
115 interleaving. Additionally you should use --verbose as well, to
116 make sure that commands are printed before they are being executed.
117 --no-config
119 Do not load the configuration file
120 --no-print-directory
122 Suppress "Entering directory" messages
123 --only-packages=PACKAGES
125 Ignore stanzas referring to a package that is not in PACKAGES.
126 PACKAGES is a comma-separated list of package names. Note that this
127 has the same effect as deleting the relevant stanzas from jbuild
128 files. It is mostly meant for releases. During development, it is
129 likely that what you want instead is to build a particular
130 <package>.install target.
131 -p PACKAGES, --for-release-of-packages=PACKAGES
133 Shorthand for --root . --only-packages PACKAGE
134 --ignore-promoted-rules --no-config --profile release. You must use
135 this option in your <package>.opam files, in order to build only
136 what's necessary when your project contains multiple packages as
137 well as getting reproducible builds.
138 --profile=VAL (absent DUNE_PROFILE env)
140 Select the build profile, for instance dev or release. The default
141 is dev.
142 --root=DIR
144 Use this directory as workspace root instead of guessing it. Note
145 that this option doesn't change the interpretation of targets given
146 on the command line. It is only intended for scripts.
147 --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env)
149 Store original source location in dune-package metadata
150 --trace-file=FILE
152 Output trace data in catapult format (compatible with
153 chrome://tracing)
154 --verbose
156 Same as --display verbose
157 --workspace=FILE (absent DUNE_WORKSPACE env)
159 Use this specific workspace file instead of looking it up.
160 -x VAL
162 Cross-compile using this toolchain.
163
165 Use `dune COMMAND --help' for help on a single command.
166
168 These environment variables affect the execution of rules:
169 DUNE_BUILD_DIR
171 Specified build directory. _build if unspecified
172 DUNE_PROFILE
174 Build profile. dev if unspecified or release if -p is set.
175 DUNE_STORE_ORIG_SOURCE_DIR
177 Store original source location in dune-package metadata
178 DUNE_WORKSPACE
180 Use this specific workspace file instead of looking it up.
181
183 Check bug reports at https://github.com/ocaml/dune/issues
184Dune n/a dune-rules(1)