Skip to content
Snippets Groups Projects
Commit d32ec703 authored by Emily Pillmore's avatar Emily Pillmore :ocean:
Browse files

output warning for doc files specified with cabal spec < 1.18

parent e398baa1
No related branches found
No related tags found
No related merge requests found
...@@ -94,7 +94,7 @@ createProject v pkgIx srcDb initFlags = do ...@@ -94,7 +94,7 @@ createProject v pkgIx srcDb initFlags = do
isMinimal <- getMinimal initFlags isMinimal <- getMinimal initFlags
doOverwrite <- getOverwrite initFlags doOverwrite <- getOverwrite initFlags
pkgDir <- getPackageDir initFlags pkgDir <- getPackageDir initFlags
pkgDesc <- fixupDocFiles <$> genPkgDescription initFlags srcDb pkgDesc <- fixupDocFiles v =<< genPkgDescription initFlags srcDb
let pkgName = _pkgName pkgDesc let pkgName = _pkgName pkgDesc
mkOpts cs = WriteOpts mkOpts cs = WriteOpts
......
...@@ -102,7 +102,7 @@ createProject comp v pkgIx srcDb initFlags = do ...@@ -102,7 +102,7 @@ createProject comp v pkgIx srcDb initFlags = do
isMinimal <- getMinimal initFlags isMinimal <- getMinimal initFlags
doOverwrite <- getOverwrite initFlags doOverwrite <- getOverwrite initFlags
pkgDir <- packageDirHeuristics initFlags pkgDir <- packageDirHeuristics initFlags
pkgDesc <- fixupDocFiles <$> genPkgDescription initFlags srcDb pkgDesc <- fixupDocFiles v =<< genPkgDescription initFlags srcDb
comments <- noCommentsHeuristics initFlags comments <- noCommentsHeuristics initFlags
let pkgName = _pkgName pkgDesc let pkgName = _pkgName pkgDesc
......
...@@ -14,7 +14,7 @@ import Distribution.Verbosity ...@@ -14,7 +14,7 @@ import Distribution.Verbosity
import Distribution.Simple.PackageIndex import Distribution.Simple.PackageIndex
import Distribution.Client.Types.SourcePackageDb (SourcePackageDb(..)) import Distribution.Client.Types.SourcePackageDb (SourcePackageDb(..))
import qualified Data.List.NonEmpty as NEL import qualified Data.List.NonEmpty as NEL
import Distribution.Client.Init.Utils (currentDirPkgName, mkPackageNameDep) import Distribution.Client.Init.Utils (currentDirPkgName, mkPackageNameDep, fixupDocFiles)
import Distribution.Client.Init.Defaults import Distribution.Client.Init.Defaults
import Distribution.Simple.Flag (fromFlagOrDefault, flagElim) import Distribution.Simple.Flag (fromFlagOrDefault, flagElim)
import Distribution.Client.Init.FlagExtractors import Distribution.Client.Init.FlagExtractors
...@@ -33,7 +33,7 @@ createProject v _pkgIx _srcDb initFlags = do ...@@ -33,7 +33,7 @@ createProject v _pkgIx _srcDb initFlags = do
isMinimal <- getMinimal initFlags isMinimal <- getMinimal initFlags
doOverwrite <- getOverwrite initFlags doOverwrite <- getOverwrite initFlags
pkgDir <- getPackageDir initFlags pkgDir <- getPackageDir initFlags
pkgDesc <- genSimplePkgDesc initFlags pkgDesc <- fixupDocFiles v =<< genSimplePkgDesc initFlags
let pkgName = _pkgName pkgDesc let pkgName = _pkgName pkgDesc
mkOpts cs = WriteOpts mkOpts cs = WriteOpts
......
...@@ -269,11 +269,17 @@ mkPackageNameDep pkg = mkDependency pkg anyVersion (NES.singleton LMainLibName) ...@@ -269,11 +269,17 @@ mkPackageNameDep pkg = mkDependency pkg anyVersion (NES.singleton LMainLibName)
-- so whatever the user wants as doc files should be dumped into -- so whatever the user wants as doc files should be dumped into
-- extra-src-files. -- extra-src-files.
-- --
fixupDocFiles :: PkgDescription -> PkgDescription fixupDocFiles :: Interactive m => Verbosity -> PkgDescription -> m PkgDescription
fixupDocFiles pkgDesc fixupDocFiles v pkgDesc
| _pkgCabalVersion pkgDesc < CabalSpecV1_18 = pkgDesc | _pkgCabalVersion pkgDesc < CabalSpecV1_18 = do
{ _pkgExtraSrcFiles =_pkgExtraSrcFiles pkgDesc message v $ concat
<> fromMaybe mempty (_pkgExtraDocFiles pkgDesc) [ "Cabal spec versions < 1.18 do not support extra-doc-files. "
, _pkgExtraDocFiles = Nothing , "Doc files will be treated as extra-src-files."
} ]
| otherwise = pkgDesc
return $ pkgDesc
{ _pkgExtraSrcFiles =_pkgExtraSrcFiles pkgDesc
<> fromMaybe mempty (_pkgExtraDocFiles pkgDesc)
, _pkgExtraDocFiles = Nothing
}
| otherwise = return pkgDesc
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment