Skip to content

Commit 9dae379

Browse files
typedrat23Skidoo
authored andcommitted
Add docs
[ci skip]
1 parent a5f728f commit 9dae379

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

Cabal/doc/nix-local-build-overview.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ names are only temporary until Nix-style local builds become the default.
88
This is expected to happen soon. For those who do not wish to use the new
99
functionality, the classic project style will not be removed immediately,
1010
but these legacy commands will require the usage of the ``v1-`` prefix as of
11-
Cabal 3.0 and will be removed in a future release.
11+
Cabal 3.0 and will be removed in a future release. For a future-proof
12+
way to use these commands in a script or tutorial that anticipates the
13+
possibility of another UI paradigm being devised in the future, there
14+
are also ``v2-`` prefixed versions that will reference the same functionality
15+
until such a point as it is completely removed from Cabal.
1216

1317
Nix-style local builds combine the best of non-sandboxed and sandboxed Cabal:
1418

cabal-install/changelog

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
-*-change-log-*-
22

33
2.4.0.0 (current development version)
4-
* 'outdated' now accepts '--project-file FILE', which will look for bounds
5-
from the new-style freeze file named FILE.freeze. This is only
6-
available when `--new-freeze-file` has been passed.
4+
* Add aliases for the "new-" commands that won't change when they
5+
lose their prefix or are eventually replaced by a third UI
6+
paradigm in the future. (#5429)
7+
* 'outdated' now accepts '--project-file FILE', which will look for bounds
8+
from the new-style freeze file named FILE.freeze. This is only
9+
available when `--new-freeze-file` has been passed.
710
* 'new-repl' now accepts a '--build-depends' flag which accepts the
811
same syntax as is used in .cabal files to add additional dependencies
912
to the environment when developing in the REPL. It is now usable outside

0 commit comments

Comments
 (0)