Rename some functions.

Rename a bunch of functions of type 'Foo -> String' from 'debugFoo' to
'showFoo'.

Author: 23Skidoo

cabal-install/Distribution/Client/Dependency.hs

@@ -73,9 +73,9 @@ import Distribution.Client.Types
          , ConfiguredPackage(..), ConfiguredId(..), enableStanzas )
 import Distribution.Client.Dependency.Types
          ( PreSolver(..), Solver(..), DependencyResolver, ResolverPackage(..)
-         , PackageConstraint(..), debugPackageConstraint
+         , PackageConstraint(..), showPackageConstraint
          , LabeledPackageConstraint(..), unlabelPackageConstraint
-         , ConstraintSource(..), debugConstraintSource
+         , ConstraintSource(..), showConstraintSource
          , AllowNewer(..), PackagePreferences(..), InstalledPreference(..)
          , PackagesPreferenceDefault(..)
          , Progress(..), foldProgress )
@@ -149,19 +149,20 @@ data DepResolverParams = DepResolverParams {
        depResolverMaxBackjumps      :: Maybe Int
      }
 
-debugDepResolverParams :: DepResolverParams -> String
-debugDepResolverParams p =
+showDepResolverParams :: DepResolverParams -> String
+showDepResolverParams p =
      "targets: " ++ intercalate ", " (map display (depResolverTargets p))
   ++ "\nconstraints: "
-  ++   concatMap (("\n  " ++) . debugLabeledConstraint)
+  ++   concatMap (("\n  " ++) . showLabeledConstraint)
        (depResolverConstraints p)
   ++ "\npreferences: "
-  ++   concatMap (("\n  " ++) . debugPackagePreference)
+  ++   concatMap (("\n  " ++) . showPackagePreference)
        (depResolverPreferences p)
   ++ "\nstrategy: " ++ show (depResolverPreferenceDefault p)
   where
-    debugLabeledConstraint (LabeledPackageConstraint pc src) =
-        debugPackageConstraint pc ++ " (" ++ debugConstraintSource src ++ ")"
+    showLabeledConstraint :: LabeledPackageConstraint -> String
+    showLabeledConstraint (LabeledPackageConstraint pc src) =
+        showPackageConstraint pc ++ " (" ++ showConstraintSource src ++ ")"
 
 -- | A package selection preference for a particular package.
 --
@@ -180,10 +181,10 @@ data PackagePreference =
 -- | Provide a textual representation of a package preference
 -- for debugging purposes.
 --
-debugPackagePreference :: PackagePreference -> String
-debugPackagePreference (PackageVersionPreference   pn vr) =
+showPackagePreference :: PackagePreference -> String
+showPackagePreference (PackageVersionPreference   pn vr) =
   display pn ++ " " ++ display (simplifyVersionRange vr)
-debugPackagePreference (PackageInstalledPreference pn ip) =
+showPackagePreference (PackageInstalledPreference pn ip) =
   display pn ++ " " ++ show ip
 
 basicDepResolverParams :: InstalledPackageIndex
@@ -545,7 +546,7 @@ resolveDependencies platform comp _solver params
 
 resolveDependencies platform comp  solver params =
 
-    Step (debugDepResolverParams finalparams)
+    Step (showDepResolverParams finalparams)
   $ fmap (validateSolverResult platform comp indGoals)
   $ runSolver solver (SolverConfig reorderGoals indGoals noReinstalls
                       shadowing strFlags maxBkjumps)

cabal-install/Distribution/Client/Dependency/Modular/Message.hs

@@ -13,7 +13,7 @@ import Distribution.Client.Dependency.Modular.Flag
 import Distribution.Client.Dependency.Modular.Package
 import Distribution.Client.Dependency.Modular.Tree
 import Distribution.Client.Dependency.Types
-         ( ConstraintSource(..), debugConstraintSource )
+         ( ConstraintSource(..), showConstraintSource )
 
 data Message =
     Enter           -- ^ increase indentation level
@@ -97,10 +97,10 @@ showFR _ CannotInstall                    = " (only already installed instances
 showFR _ CannotReinstall                  = " (avoiding to reinstall a package with same version but new dependencies)"
 showFR _ Shadowed                         = " (shadowed by another installed package with same version)"
 showFR _ Broken                           = " (package is broken)"
-showFR _ (GlobalConstraintVersion vr src) = " (" ++ showConstraintSource src ++ " requires " ++ display vr ++ ")"
-showFR _ (GlobalConstraintInstalled src)  = " (" ++ showConstraintSource src ++ " requires installed instance)"
-showFR _ (GlobalConstraintSource src)     = " (" ++ showConstraintSource src ++ " requires source instance)"
-showFR _ (GlobalConstraintFlag src)       = " (" ++ showConstraintSource src ++ " requires opposite flag selection)"
+showFR _ (GlobalConstraintVersion vr src) = " (" ++ constraintSource src ++ " requires " ++ display vr ++ ")"
+showFR _ (GlobalConstraintInstalled src)  = " (" ++ constraintSource src ++ " requires installed instance)"
+showFR _ (GlobalConstraintSource src)     = " (" ++ constraintSource src ++ " requires source instance)"
+showFR _ (GlobalConstraintFlag src)       = " (" ++ constraintSource src ++ " requires opposite flag selection)"
 showFR _ ManualFlag                       = " (manual flag can only be changed explicitly)"
 showFR _ (BuildFailureNotInIndex pn)      = " (unknown package: " ++ display pn ++ ")"
 showFR c Backjump                         = " (backjumping, conflict set: " ++ showCS c ++ ")"
@@ -113,5 +113,5 @@ showFR _ (MalformedFlagChoice qfn)        = " (INTERNAL ERROR: MALFORMED FLAG CH
 showFR _ (MalformedStanzaChoice qsn)      = " (INTERNAL ERROR: MALFORMED STANZA CHOICE: " ++ showQSN qsn ++ ")"
 showFR _ EmptyGoalChoice                  = " (INTERNAL ERROR: EMPTY GOAL CHOICE)"
 
-showConstraintSource :: ConstraintSource -> String
-showConstraintSource src = "constraint from " ++ debugConstraintSource src
+constraintSource :: ConstraintSource -> String
+constraintSource src = "constraint from " ++ showConstraintSource src

cabal-install/Distribution/Client/Dependency/Types.hs

@@ -20,7 +20,7 @@ module Distribution.Client.Dependency.Types (
 
     AllowNewer(..), isAllowNewer,
     PackageConstraint(..),
-    debugPackageConstraint,
+    showPackageConstraint,
     PackagePreferences(..),
     InstalledPreference(..),
     PackagesPreferenceDefault(..),
@@ -31,7 +31,7 @@ module Distribution.Client.Dependency.Types (
     LabeledPackageConstraint(..),
     ConstraintSource(..),
     unlabelPackageConstraint,
-    debugConstraintSource
+    showConstraintSource
   ) where
 
 #if !MIN_VERSION_base(4,8,0)
@@ -138,19 +138,19 @@ data PackageConstraint
 -- | Provide a textual representation of a package constraint
 -- for debugging purposes.
 --
-debugPackageConstraint :: PackageConstraint -> String
-debugPackageConstraint (PackageConstraintVersion pn vr) =
+showPackageConstraint :: PackageConstraint -> String
+showPackageConstraint (PackageConstraintVersion pn vr) =
   display pn ++ " " ++ display (simplifyVersionRange vr)
-debugPackageConstraint (PackageConstraintInstalled pn) =
+showPackageConstraint (PackageConstraintInstalled pn) =
   display pn ++ " installed"
-debugPackageConstraint (PackageConstraintSource pn) =
+showPackageConstraint (PackageConstraintSource pn) =
   display pn ++ " source"
-debugPackageConstraint (PackageConstraintFlags pn fs) =
+showPackageConstraint (PackageConstraintFlags pn fs) =
   "flags " ++ display pn ++ " " ++ unwords (map (uncurry showFlag) fs)
   where
     showFlag (FlagName f) True  = "+" ++ f
     showFlag (FlagName f) False = "-" ++ f
-debugPackageConstraint (PackageConstraintStanzas pn ss) =
+showPackageConstraint (PackageConstraintStanzas pn ss) =
   "stanzas " ++ display pn ++ " " ++ unwords (map showStanza ss)
   where
     showStanza TestStanzas  = "test"
@@ -301,19 +301,19 @@ data ConstraintSource =
   deriving (Eq, Show)
 
 -- | Description of a 'ConstraintSource'.
-debugConstraintSource :: ConstraintSource -> String
-debugConstraintSource (ConstraintSourceMainConfig path) =
+showConstraintSource :: ConstraintSource -> String
+showConstraintSource (ConstraintSourceMainConfig path) =
     "main config " ++ path
-debugConstraintSource (ConstraintSourceSandboxConfig path) =
+showConstraintSource (ConstraintSourceSandboxConfig path) =
     "sandbox config " ++ path
-debugConstraintSource ConstraintSourceUserConfig = "cabal.config"
-debugConstraintSource ConstraintSourceCommandlineFlag = "command line flag"
-debugConstraintSource ConstraintSourceUserTarget = "user target"
-debugConstraintSource ConstraintSourceNonUpgradeablePackage =
+showConstraintSource ConstraintSourceUserConfig = "cabal.config"
+showConstraintSource ConstraintSourceCommandlineFlag = "command line flag"
+showConstraintSource ConstraintSourceUserTarget = "user target"
+showConstraintSource ConstraintSourceNonUpgradeablePackage =
     "non-upgradeable package"
-debugConstraintSource ConstraintSourceModifiedAddSourceDep =
+showConstraintSource ConstraintSourceModifiedAddSourceDep =
     "modified add-source dependency"
-debugConstraintSource ConstraintSourceFreeze = "cabal freeze"
-debugConstraintSource ConstraintSourceConfigFlagOrTarget =
+showConstraintSource ConstraintSourceFreeze = "cabal freeze"
+showConstraintSource ConstraintSourceConfigFlagOrTarget =
     "config file, command line flag, or user target"
-debugConstraintSource ConstraintSourceUnknown = "unknown source"
+showConstraintSource ConstraintSourceUnknown = "unknown source"