Merge pull request #3953 from 23Skidoo/backport-3873

Backport #3873 to the 1.24 branch

Author: ezyang

Cabal/Distribution/Simple/Configure.hs

@@ -42,6 +42,7 @@ module Distribution.Simple.Configure (configure,
                                       getPackageDBContents,
                                       configCompiler, configCompilerAux,
                                       configCompilerEx, configCompilerAuxEx,
+                                      computeEffectiveProfiling,
                                       ccLdOptionsBuildInfo,
                                       checkForeignDeps,
                                       interpretPackageDbFlags,
@@ -310,6 +311,29 @@ findDistPrefOrDefault :: Setup.Flag FilePath  -- ^ override \"dist\" prefix
                       -> IO FilePath
 findDistPrefOrDefault = findDistPref defaultDistPref
 
+-- | Compute the effective value of the profiling flags
+-- @--enable-library-profiling@ and @--enable-executable-profiling@
+-- from the specified 'ConfigFlags'.  This may be useful for
+-- external Cabal tools which need to interact with Setup in
+-- a backwards-compatible way: the most predictable mechanism
+-- for enabling profiling across many legacy versions is to
+-- NOT use @--enable-profiling@ and use those two flags instead.
+--
+-- Note that @--enable-executable-profiling@ also affects profiling
+-- of benchmarks and (non-detailed) test suites.
+computeEffectiveProfiling :: ConfigFlags -> (Bool {- lib -}, Bool {- exe -})
+computeEffectiveProfiling cfg =
+    -- The --profiling flag sets the default for both libs and exes,
+    -- but can be overidden by --library-profiling, or the old deprecated
+    -- --executable-profiling flag.
+    --
+    -- The --profiling-detail and --library-profiling-detail flags behave
+    -- similarly
+    let profEnabledBoth = fromFlagOrDefault False (configProf cfg)
+        profEnabledLib  = fromFlagOrDefault profEnabledBoth (configProfLib cfg)
+        profEnabledExe  = fromFlagOrDefault profEnabledBoth (configProfExe cfg)
+    in (profEnabledLib, profEnabledExe)
+
 -- |Perform the \"@.\/setup configure@\" action.
 -- Returns the @.setup-config@ file.
 configure :: (GenericPackageDescription, HookedBuildInfo)
@@ -578,16 +602,8 @@ configure (pkg_descr0', pbi) cfg = do
         ++ "is not being built. Linking will fail if any executables "
         ++ "depend on the library."
 
-    -- The --profiling flag sets the default for both libs and exes,
-    -- but can be overidden by --library-profiling, or the old deprecated
-    -- --executable-profiling flag.
-    let profEnabledLibOnly = configProfLib cfg
-        profEnabledBoth    = fromFlagOrDefault False (configProf cfg)
-        profEnabledLib = fromFlagOrDefault profEnabledBoth profEnabledLibOnly
-        profEnabledExe = fromFlagOrDefault profEnabledBoth (configProfExe cfg)
+    let (profEnabledLib, profEnabledExe) = computeEffectiveProfiling cfg
 
-    -- The --profiling-detail and --library-profiling-detail flags behave
-    -- similarly
     profDetailLibOnly <- checkProfDetail (configProfLibDetail cfg)
     profDetailBoth    <- liftM (fromFlagOrDefault ProfDetailDefault)
                                (checkProfDetail (configProfDetail cfg))

cabal-install/Distribution/Client/Setup.hs

@@ -73,6 +73,7 @@ import Distribution.Simple.Program
          ( defaultProgramConfiguration )
 import Distribution.Simple.Command hiding (boolOpt, boolOpt')
 import qualified Distribution.Simple.Command as Command
+import Distribution.Simple.Configure ( computeEffectiveProfiling )
 import qualified Distribution.Simple.Setup as Cabal
 import Distribution.Simple.Setup
          ( ConfigFlags(..), BuildFlags(..), ReplFlags
@@ -363,6 +364,7 @@ filterConfigureFlags flags cabalLibVersion
   | cabalLibVersion <  Version [1,23,0] [] = flags_1_22_0
   | otherwise = flags_latest
   where
+    (profEnabledLib, profEnabledExe) = computeEffectiveProfiling flags
     flags_latest = flags        {
       -- Cabal >= 1.19.1 uses '--dependency' and does not need '--constraint'.
       configConstraints = [],
@@ -372,21 +374,24 @@ filterConfigureFlags flags cabalLibVersion
       }
 
     -- Cabal < 1.23 doesn't know about '--profiling-detail'.
+    -- Cabal < 1.23 has a hacked up version of 'enable-profiling'
+    -- which we shouldn't use.
     flags_1_22_0 = flags_latest { configProfDetail    = NoFlag
                                 , configProfLibDetail = NoFlag
-                                , configIPID          = NoFlag }
+                                , configIPID          = NoFlag
+                                , configProf          = NoFlag
+                                , configProfExe       = Flag profEnabledExe
+                                , configProfLib       = Flag profEnabledLib
+                                }
 
     -- Cabal < 1.22 doesn't know about '--disable-debug-info'.
     flags_1_21_0 = flags_1_22_0 { configDebugInfo = NoFlag }
 
     -- Cabal < 1.21.1 doesn't know about 'disable-relocatable'
     -- Cabal < 1.21.1 doesn't know about 'enable-profiling'
+    -- (but we already dealt with it in flags_1_22_0)
     flags_1_20_0 =
       flags_1_21_0 { configRelocatable = NoFlag
-                   , configProf = NoFlag
-                   , configProfExe = configProf flags
-                   , configProfLib =
-                     mappend (configProf flags) (configProfLib flags)
                    , configCoverage = NoFlag
                    , configLibCoverage = configCoverage flags
                    }

cabal-install/cabal-install.cabal

@@ -1,5 +1,5 @@
 Name:               cabal-install
-Version:            1.24.0.0
+Version:            1.24.0.1
 Synopsis:           The command-line interface for Cabal and Hackage.
 Description:
     The \'cabal\' command-line program simplifies the process of managing

cabal-install/changelog

@@ -1,5 +1,7 @@
 -*-change-log-*-
-1.24.0.1 Ryan Thomas <[email protected]> June 2016
+1.24.0.1 Ryan Thomas <[email protected]> October 2016
+	* Fixed issue with passing '--enable-profiling' when invoking
+	Setup scripts built with older versions of Cabal (#3873).
 	* Fixed various behaviour differences between network transports
 	(#3429).
 	* Updated to depend on the latest hackage-security that fixes