Add docs

[ci skip]
haskell · Jul 12, 2018 · 98afe74 · 98afe74
1 parent f0b462b
commit 98afe74
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/Cabal/doc/nix-local-build-overview.rst b/Cabal/doc/nix-local-build-overview.rst
@@ -8,7 +8,11 @@ names are only temporary until Nix-style local builds become the default.
 This is expected to happen soon. For those who do not wish to use the new
 functionality, the classic project style will not be removed immediately,
 but these legacy commands will require the usage of the ``v1-`` prefix as of
-Cabal 3.0 and will be removed in a future release.
+Cabal 3.0 and will be removed in a future release. For a future-proof
+way to use these commands in a script or tutorial that anticipates the
+possibility of another UI paradigm being devised in the future, there
+are also ``v2-`` prefixed versions that will reference the same functionality
+until such a point as it is completely removed from Cabal.
 
 Nix-style local builds combine the best of non-sandboxed and sandboxed Cabal:
 

diff --git a/cabal-install/changelog b/cabal-install/changelog
@@ -1,6 +1,9 @@
 -*-change-log-*-
 
 2.4.0.0 (current development version)
+	* Add aliases for the "new-" commands that won't change when they 
+	  lose their prefix or are eventually replaced by a third UI 
+	  paradigm in the future. (#5429)
 	* Drop support for GHC 7.4, since it is out of our support window
       (and has been for over a year!)
 	* 'new-update' now works outside of projects. (#5096)