Skip to content

Commit 83f3a1e

Browse files
committed
Changelog entry and docs update for #7402
1 parent 8b9fbf1 commit 83f3a1e

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

changelog.d/pr-7402

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
synopsis: changes to cabal v2-configure
2+
packages: cabal-install
3+
prs: #7402
4+
issues: #5591 #7180 #7405
5+
6+
description: {
7+
8+
- Removes the --dry-run part of the v2-configure command
9+
- Adds an --append flag to v2-configure, which allows new configuration to be appended to the old config file
10+
- Adds an --overwrite flag to v2-configure, which disables the backup feature for the config file
11+
- Includes unit tests for everything
12+
13+
}

doc/cabal-commands.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,15 @@ to happen if a flag actually applied to every transitive dependency). To
4242
apply options to an external package, use a ``package`` stanza in a
4343
``cabal.project`` file.
4444

45+
There are two ways of modifying the ``cabal.project.local`` file through
46+
``cabal v2-configure``, either by appending new configurations to it, or
47+
by simply overwriting it all. Overwriting is the default behaviour, as
48+
such, there's a flag ``--enable-append`` to append the new configurations
49+
instead. Since overwriting is rather destructive in nature, a backup system
50+
is in place, which moves the old configuration to a ``cabal.project.local~``
51+
file, this feature can also be disabled by using the ``--enable-overwrite``
52+
flag.
53+
4554
cabal v2-update
4655
----------------
4756

0 commit comments

Comments
 (0)