Add deprecation warnings to Nix integration

https://cabal.readthedocs.io/en/latest/nix-integration.html
haskell · Sep 2, 2023 · 51b92ee · 51b92ee
1 parent 30bb110
commit 51b92ee
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 4 deletions.
diff --git a/cabal-install/src/Distribution/Client/Nix.hs b/cabal-install/src/Distribution/Client/Nix.hs
@@ -47,7 +47,7 @@ import Distribution.Simple.Program
   , simpleProgram
   )
 import Distribution.Simple.Setup (fromFlagOrDefault)
-import Distribution.Simple.Utils (debug, existsAndIsMoreRecentThan)
+import Distribution.Simple.Utils (debug, existsAndIsMoreRecentThan, warn)
 
 import Distribution.Client.Config (SavedConfig (..))
 import Distribution.Client.GlobalFlags (GlobalFlags (..))
@@ -141,6 +141,9 @@ nixShell verb dist globalFlags config go = do
   if alreadyInShell
     then go
     else do
+      -- Nix integration never worked with cabal-install v2 commands ...
+      warn verb "Nix integration has been deprecated and will be removed in a future release. You can learn more about it here: https://cabal.readthedocs.io/en/latest/nix-integration.html"
+
       findNixExpr globalFlags config >>= \case
         Nothing -> go
         Just shellNix -> do

diff --git a/cabal-install/src/Distribution/Client/Setup.hs b/cabal-install/src/Distribution/Client/Setup.hs
@@ -502,17 +502,17 @@ globalCommand commands =
               )
               ""
               ["nix"] -- Must be empty because we need to return PP.empty from viewAsFieldDescr
-              "Nix integration: run commands through nix-shell if a 'shell.nix' file exists (default is False)"
+              "[DEPRECATED] Nix integration: run commands through nix-shell if a 'shell.nix' file exists (default is False)"
           , noArg
               (Flag True)
               []
               ["enable-nix"]
-              "Enable Nix integration: run commands through nix-shell if a 'shell.nix' file exists"
+              "[DEPRECATED] Enable Nix integration: run commands through nix-shell if a 'shell.nix' file exists"
           , noArg
               (Flag False)
               []
               ["disable-nix"]
-              "Disable Nix integration"
+              "[DEPRECATED] Disable Nix integration"
           ]
       , option
           []

diff --git a/cabal-testsuite/PackageTests/Freeze/enable-benchmarks.out b/cabal-testsuite/PackageTests/Freeze/enable-benchmarks.out
@@ -1,4 +1,5 @@
 # cabal v2-update
 Downloading the latest package list from test-local-repo
 # cabal v1-freeze
+Warning: Nix integration has been deprecated and will be removed in a future release. You can learn more about it here: https://cabal.readthedocs.io/en/latest/nix-integration.html
 Resolving dependencies...
diff --git a/cabal-testsuite/PackageTests/Freeze/enable-tests.out b/cabal-testsuite/PackageTests/Freeze/enable-tests.out
@@ -1,4 +1,5 @@
 # cabal v2-update
 Downloading the latest package list from test-local-repo
 # cabal v1-freeze
+Warning: Nix integration has been deprecated and will be removed in a future release. You can learn more about it here: https://cabal.readthedocs.io/en/latest/nix-integration.html
 Resolving dependencies...
diff --git a/doc/nix-integration.rst b/doc/nix-integration.rst
@@ -1,6 +1,15 @@
 Nix Integration
 ===============
 
+.. warning::
+
+    Nix integration has been deprecated and will be removed in a future release.
+
+    The original mechanism can still be easily replicated with the following commands:
+
+    - for a ``shell.nix``: ``nix-shell --run "cabal ..."``
+    - for a ``flake.nix``: ``nix develop -c cabal ...``
+
 .. note::
 
     This functionality doesn't work with nix-style builds.