Merge of #11339

mergify[bot] · web-flow · commit ff192d2f4c78 · 2026-03-11T01:30:24.000Z
diff --git a/Cabal/Cabal.cabal b/Cabal/Cabal.cabal
@@ -100,6 +100,7 @@ library
     Distribution.Compat.Prelude.Internal
     Distribution.Compat.Process
     Distribution.Compat.Stack
+    Distribution.Compat.SysInfo
     Distribution.Compat.Time
     Distribution.Make
     Distribution.PackageDescription.Check
diff --git a/Cabal/src/Distribution/Compat/SysInfo.hs b/Cabal/src/Distribution/Compat/SysInfo.hs
@@ -0,0 +1,15 @@
+{-# LANGUAGE CPP #-}
+
+module Distribution.Compat.SysInfo
+  ( fullCompilerVersion
+  ) where
+
+import Data.Version (Version)
+import qualified System.Info as SI
+
+fullCompilerVersion :: Version
+#if MIN_VERSION_base(4,15,0)
+fullCompilerVersion = SI.fullCompilerVersion
+#else
+fullCompilerVersion = SI.compilerVersion
+#endif
diff --git a/Cabal/src/Distribution/Make.hs b/Cabal/src/Distribution/Make.hs
@@ -105,6 +105,7 @@ defaultMainHelperWithHandles verbHandles args = do
       case commandParse of
         _
           | fromFlag (globalVersion flags) -> printVersion
+          | fromFlag (globalFullVersion flags) -> printFullVersion
           | fromFlag (globalNumericVersion flags) -> printNumericVersion
         CommandHelp help -> printHelp help
         CommandList opts -> printOptionsList opts
@@ -122,6 +123,16 @@ defaultMainHelperWithHandles verbHandles args = do
       hPutStrLn outHandle $
         "Cabal library version "
           ++ prettyShow cabalVersion
+    printFullVersion =
+      hPutStrLn outHandle $
+        "Cabal library version "
+          ++ prettyShow cabalVersion
+          ++ cabalGitInfo'
+          ++ "\nwith "
+          ++ cabalCompilerInfo
+    cabalGitInfo'
+      | null cabalGitInfo = []
+      | otherwise = ' ' : cabalGitInfo
     progs = defaultProgramDb
     commands =
       [ configureCommand progs `commandAddAction` configureAction verbHandles
diff --git a/Cabal/src/Distribution/Simple.hs b/Cabal/src/Distribution/Simple.hs
@@ -329,6 +329,7 @@ defaultMainHelperWithHandles verbHandles hooks args =
         case commandParse of
           _
             | fromFlag (globalVersion globalFlags) -> printVersion
+            | fromFlag (globalFullVersion globalFlags) -> printFullVersion
             | fromFlag (globalNumericVersion globalFlags) -> printNumericVersion
           CommandHelp help -> printHelp help
           CommandList opts -> printOptionsList opts
@@ -347,7 +348,16 @@ defaultMainHelperWithHandles verbHandles hooks args =
       hPutStrLn outHandle $
         "Cabal library version "
           ++ prettyShow cabalVersion
-
+    printFullVersion =
+      hPutStrLn outHandle $
+        "Cabal library version "
+          ++ prettyShow cabalVersion
+          ++ cabalGitInfo'
+          ++ "\nwith "
+          ++ cabalCompilerInfo
+    cabalGitInfo'
+      | null cabalGitInfo = []
+      | otherwise = ' ' : cabalGitInfo
     progs = addKnownPrograms (hookedPrograms hooks) defaultProgramDb
     addAction
       :: CommandUI flags
diff --git a/Cabal/src/Distribution/Simple/Setup/Global.hs b/Cabal/src/Distribution/Simple/Setup/Global.hs
@@ -44,6 +44,7 @@ import Distribution.Utils.Path
 -- | Flags that apply at the top level, not to any sub-command.
 data GlobalFlags = GlobalFlags
   { globalVersion :: Flag Bool
+  , globalFullVersion :: Flag Bool
   , globalNumericVersion :: Flag Bool
   , globalWorkingDir :: Flag (SymbolicPath CWD (Dir Pkg))
   }
@@ -53,6 +54,7 @@ defaultGlobalFlags :: GlobalFlags
 defaultGlobalFlags =
   GlobalFlags
     { globalVersion = Flag False
+    , globalFullVersion = Flag False
     , globalNumericVersion = Flag False
     , globalWorkingDir = NoFlag
     }
@@ -101,6 +103,13 @@ globalCommand commands =
             globalVersion
             (\v flags -> flags{globalVersion = v})
             trueArg
+        , option
+            []
+            ["full-version"]
+            "Print the version, Git revision if available, and compiler information"
+            globalFullVersion
+            (\v flags -> flags{globalFullVersion = v})
+            trueArg
         , option
             []
             ["numeric-version"]
diff --git a/Cabal/src/Distribution/Simple/Utils.hs b/Cabal/src/Distribution/Simple/Utils.hs
@@ -33,6 +33,7 @@
 module Distribution.Simple.Utils
   ( cabalVersion
   , cabalGitInfo
+  , cabalCompilerInfo
 
     -- * logging and errors
   , dieNoVerbosity
@@ -213,6 +214,7 @@ import Distribution.Compat.Internal.TempFile
 import Distribution.Compat.Lens (Lens', over)
 import Distribution.Compat.Prelude
 import Distribution.Compat.Stack
+import Distribution.Compat.SysInfo as SIC
 import Distribution.ModuleName as ModuleName
 import Distribution.Simple.Errors
 import Distribution.Simple.PreProcess.Types
@@ -244,6 +246,7 @@ import Data.Typeable
 
 import qualified Control.Exception as Exception
 import Data.Time.Clock.POSIX (POSIXTime, getPOSIXTime)
+import qualified Data.Version as DV
 import Distribution.Compat.Process (proc)
 import Foreign.C.Error (Errno (..), ePIPE)
 import qualified GHC.IO.Exception as GHC
@@ -294,6 +297,7 @@ import System.IO.Error
 import System.IO.Unsafe
   ( unsafeInterleaveIO
   )
+import qualified System.Info as SI
 import qualified System.Process as Process
 import qualified Text.PrettyPrint as Disp
 
@@ -331,20 +335,35 @@ cabalGitInfo = if giHash' == ""
                  else concat [ "(commit "
                              , giHash'
                              , branchInfo
-                             , ", "
-                             , either (const "") giCommitDate gi'
+                             , either (const "") ((", " ++) . giCommitDate) gi'
                              , ")"
                              ]
   where
     gi' = $$tGitInfoCwdTry
     giHash' = take 7 . either (const "") giHash $ gi'
+    branch = either id giBranch gi'
     branchInfo | isLeft gi' = ""
-               | either id giBranch gi' == "master" = ""
-               | otherwise = " on " <> either id giBranch gi'
+               | branch == "master" = ""
+               | otherwise = " on " <> branch
 #else
 cabalGitInfo = ""
 #endif
 
+-- |
+-- `Cabal` compiler information, reported by `--version-full` but otherwise
+-- unused.
+cabalCompilerInfo :: String
+cabalCompilerInfo =
+  concat
+    [ SI.compilerName
+    , " "
+    , intercalate "." (map show (DV.versionBranch SIC.fullCompilerVersion))
+    , " on "
+    , SI.os
+    , " "
+    , SI.arch
+    ]
+
 -- ----------------------------------------------------------------------------
 -- Exception and logging utils
 
diff --git a/cabal-install/src/Distribution/Client/Config.hs b/cabal-install/src/Distribution/Client/Config.hs
@@ -359,6 +359,7 @@ instance Semigroup SavedConfig where
       combinedSavedGlobalFlags =
         GlobalFlags
           { globalVersion = combine globalVersion
+          , globalFullVersion = combine globalFullVersion
           , globalNumericVersion = combine globalNumericVersion
           , globalConfigFile = combine globalConfigFile
           , globalConstraintsFile = combine globalConstraintsFile
diff --git a/cabal-install/src/Distribution/Client/GlobalFlags.hs b/cabal-install/src/Distribution/Client/GlobalFlags.hs
@@ -81,6 +81,7 @@ import qualified Hackage.Security.Util.Pretty as Sec
 -- | Flags that apply at the top level, not to any sub-command.
 data GlobalFlags = GlobalFlags
   { globalVersion :: Flag Bool
+  , globalFullVersion :: Flag Bool
   , globalNumericVersion :: Flag Bool
   , globalConfigFile :: Flag FilePath
   , globalConstraintsFile :: Flag FilePath
@@ -103,6 +104,7 @@ defaultGlobalFlags :: GlobalFlags
 defaultGlobalFlags =
   GlobalFlags
     { globalVersion = Flag False
+    , globalFullVersion = Flag False
     , globalNumericVersion = Flag False
     , globalConfigFile = mempty
     , globalConstraintsFile = mempty
diff --git a/cabal-install/src/Distribution/Client/Main.hs b/cabal-install/src/Distribution/Client/Main.hs
@@ -226,6 +226,7 @@ import Distribution.Simple.Program.Db (reconfigurePrograms)
 import qualified Distribution.Simple.Setup as Cabal
 import Distribution.Simple.Utils
   ( VerboseException
+  , cabalCompilerInfo
   , cabalGitInfo
   , cabalVersion
   , createDirectoryIfMissingVerbose
@@ -351,6 +352,8 @@ mainWorker args = do
           _
             | fromFlagOrDefault False (globalVersion globalFlags) ->
                 printVersion
+            | fromFlagOrDefault False (globalFullVersion globalFlags) ->
+                printFullVersion
             | fromFlagOrDefault False (globalNumericVersion globalFlags) ->
                 printNumericVersion
           CommandHelp help -> printCommandHelp help
@@ -421,6 +424,13 @@ mainWorker args = do
     printErrors errs = dieNoVerbosity $ intercalate "\n" errs
     printNumericVersion = putStrLn $ display cabalInstallVersion
     printVersion =
+      putStrLn $
+        "cabal-install version "
+          ++ display cabalInstallVersion
+          ++ "\ncompiled using version "
+          ++ display cabalVersion
+          ++ " of the Cabal library "
+    printFullVersion =
       putStrLn $
         "cabal-install version "
           ++ display cabalInstallVersion
@@ -429,6 +439,10 @@ mainWorker args = do
           ++ display cabalVersion
           ++ " of the Cabal library "
           ++ cabalGitInfo'
+          ++ "\nwith "
+          -- it's impossible for cabal-install to have been built with a different compiler
+          -- from Cabal, so just reuse its info
+          ++ cabalCompilerInfo
       where
         cabalInstallGitInfo'
           | null cabalInstallGitInfo = ""
diff --git a/cabal-install/src/Distribution/Client/ProjectConfig/Legacy.hs b/cabal-install/src/Distribution/Client/ProjectConfig/Legacy.hs
@@ -984,6 +984,7 @@ convertToLegacySharedConfig
       globalFlags =
         GlobalFlags
           { globalVersion = mempty
+          , globalFullVersion = mempty
           , globalNumericVersion = mempty
           , globalConfigFile = projectConfigConfigFile
           , globalConstraintsFile = mempty
diff --git a/cabal-install/src/Distribution/Client/Setup.hs b/cabal-install/src/Distribution/Client/Setup.hs
@@ -489,6 +489,13 @@ globalCommand commands =
           globalVersion
           (\v flags -> flags{globalVersion = v})
           trueArg
+      , option
+          []
+          ["full-version"]
+          "Print full version information with git revision (if available) and compiler"
+          globalFullVersion
+          (\v flags -> flags{globalFullVersion = v})
+          trueArg
       , option
           []
           ["numeric-version"]
diff --git a/cabal-install/src/Distribution/Client/Version.hs b/cabal-install/src/Distribution/Client/Version.hs
@@ -9,7 +9,11 @@ module Distribution.Client.Version
   , cabalInstallGitInfo
   ) where
 
+import Data.List (intercalate)
+import qualified Data.Version as DV
+import qualified Distribution.Compat.SysInfo as SIC
 import Distribution.Version
+import qualified System.Info as SI
 
 import qualified Paths_cabal_install as PackageInfo
 
@@ -28,6 +32,20 @@ import GitHash
 cabalInstallVersion :: Version
 cabalInstallVersion = mkVersion' PackageInfo.version
 
+-- |
+-- `cabal-install` compiler information.
+cabalInstallCompilerInfo :: String
+cabalInstallCompilerInfo =
+  concat
+    [ SI.compilerName
+    , " "
+    , intercalate "." (map show (DV.versionBranch SIC.fullCompilerVersion))
+    , " on "
+    , SI.os
+    , " "
+    , SI.arch
+    ]
+
 -- |
 -- `cabal-install` Git information. Only filled in if built in a Git tree in
 -- development mode and Template Haskell is available.
@@ -38,16 +56,16 @@ cabalInstallGitInfo = if giHash' == ""
                         else concat [ "(commit "
                                     , giHash'
                                     , branchInfo
-                                    , ", "
-                                    , either (const "") giCommitDate gi'
+                                    , either (const "") ((", " ++) . giCommitDate) gi'
                                     , ")"
                                     ]
   where
     gi' = $$tGitInfoCwdTry
     giHash' = take 7 . either (const "") giHash $ gi'
+    branch = either id giBranch gi'
     branchInfo | isLeft gi' = ""
-               | either id giBranch gi' == "master" = ""
-               | otherwise = " on " <> either id giBranch gi'
+               | branch == "master" = ""
+               | otherwise = " on " <> branch
 #else
 cabalInstallGitInfo = ""
 #endif
diff --git a/changelog.d/pr-11339 b/changelog.d/pr-11339
@@ -0,0 +1,13 @@
+---
+synopsis: Add `--version-full` option and move additional version information to it
+packages: [Cabal, cabal-install]
+prs: 11339
+---
+
+A new option `--version-full` has been added to `cabal` and `Setup.hs`. The previously added git revision information has been moved to it, and compiler and host information added to it.
+
+The `--version` option now reports the same information it originally did, in case scripts were relying on its output.
+
+Git revision information still is not provided for release builds, largely to avoid bootstrapping issues when building GHC. (Both cabal-install (not distributed, but used by hadrian) and the Cabal library are built as part of GHC builds.)
+
+This _shouldn't_ affect most people, unless someone has been relying on the output of `--version` instead of using `--numeric-version`; but they would have been forced to support both output forms, and that only if supporting unreleased cabal builds.
