Skip to content

Commit a7c6c01

Browse files
committed
Document phase control flags
--dry-run --only-dependencies --only-configure --only-download
1 parent d71d8aa commit a7c6c01

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

doc/cabal-project.rst

+25
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,31 @@ package, and thus apply globally:
269269

270270
Specifies the name of the directory of the global package store.
271271

272+
Phase control
273+
-------------
274+
275+
The following settings apply to commands that result in build actions
276+
(``build``, ``run``, ``repl``, ``test``...), and control which phases of the
277+
build are executed.
278+
279+
.. option:: --dry-run
280+
281+
Do not download, build, or install anything, only print what would happen.
282+
283+
.. option:: --only-configure
284+
285+
Instead of performing a full build just run the configure step.
286+
Only accepted by the ``build`` command.
287+
288+
.. option:: --only-download
289+
290+
Do not build anything, only fetch the packages.
291+
292+
.. option:: --only-dependencies
293+
294+
Install only the dependencies necessary to build the given packages.
295+
Not accepted by the ``repl`` command.
296+
272297
Solver configuration options
273298
----------------------------
274299

0 commit comments

Comments
 (0)