deprecation and removal messages

haskell · Sep 27, 2019 · 7f753cd · 7f753cd
1 parent 1350703
commit 7f753cd
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 29 deletions.
diff --git a/Cabal/doc/buildinfo-fields-reference.rst b/Cabal/doc/buildinfo-fields-reference.rst
@@ -49,8 +49,8 @@ build-tool-depends
 build-tools
   * monoidal field
   * format: ``{comma-separated-list={legacy-exe-dependency}}``
-  * deprecated since ``cabal-version: 2.0``
-  * removed in ``cabal-version: 3.0``
+  * deprecated since ``cabal-version: 2.0``. Please use 'build-tool-depends' field
+  * removed in ``cabal-version: 3.0``. Please use 'build-tool-depends' field.
   * more documentation about :pkg-field:`build-tools`
 
 buildable
@@ -108,8 +108,8 @@ default-language
 extensions
   * monoidal field
   * format: ``{optional-comma-separated-list={language-extension}}``
-  * deprecated since ``cabal-version: 1.12``
-  * removed in ``cabal-version: 3.0``
+  * deprecated since ``cabal-version: 1.12``. Please use 'default-extensions' or 'other-extensions' fields.
+  * removed in ``cabal-version: 3.0``. Please use 'default-extensions' or 'other-extensions' fields.
   * more documentation about :pkg-field:`extensions`
 
 extra-bundled-libraries
@@ -186,8 +186,8 @@ ghcjs-shared-options
 hs-source-dir
   * monoidal field
   * format: ``{optional-comma-separated-list={haskell-string}|[^ ,]+}``
-  * deprecated since ``cabal-version: 1.2``
-  * removed in ``cabal-version: 3.0``
+  * deprecated since ``cabal-version: 1.2``. Please use 'hs-source-dirs'
+  * removed in ``cabal-version: 3.0``. Please use 'hs-source-dirs' field.
   * more documentation about :pkg-field:`hs-source-dir`
 
 hs-source-dirs
@@ -534,7 +534,7 @@ hs-libraries
 hugs-options
   * monoidal field
   * format: ``{optional-comma-separated-list={haskell-string}|[^ ,]+}``
-  * deprecated since ``cabal-version: 1.22``
+  * deprecated since ``cabal-version: 1.22``. hugs isn't supported anymore
   * more documentation about :pkg-field:`hugs-options`
 
 id

diff --git a/buildinfo-reference-generator/src/Main.hs b/buildinfo-reference-generator/src/Main.hs
@@ -75,14 +75,17 @@ main = do
     tellavai Nothing  = return ()
     tellavai (Just v) = putStrLn $ "  * available since ``cabal-version: " ++ showCabalSpecVersion v ++ "``"
 
-    telldepr :: Maybe CabalSpecVersion -> IO ()
-    telldepr Nothing  = return ()
-    telldepr (Just v) = putStrLn $ "  * deprecated since ``cabal-version: " ++ showCabalSpecVersion v ++ "``"
-
-    tellremo :: Maybe CabalSpecVersion -> IO ()
-    tellremo Nothing  = return ()
-    tellremo (Just v) = putStrLn $ "  * removed in ``cabal-version: " ++ showCabalSpecVersion v ++ "``"
-
+    telldepr :: Maybe (CabalSpecVersion, String) -> IO ()
+    telldepr Nothing       = return ()
+    telldepr (Just (v, d)) = putStrLn $
+        "  * deprecated since ``cabal-version: " ++ showCabalSpecVersion v ++ "``. "
+        ++ d
+
+    tellremo :: Maybe (CabalSpecVersion, String) -> IO ()
+    tellremo Nothing      = return ()
+    tellremo (Just (v,d)) = putStrLn $
+        "  * removed in ``cabal-version: " ++ showCabalSpecVersion v ++ "``. "
+        ++ d
 
     outputReference :: Reference a b -> IO ()
     outputReference (Reference ref) = void $ flip Map.traverseWithKey ref $ \fn d -> case d of
@@ -152,30 +155,30 @@ referenceAvailableSince :: CabalSpecVersion -> Reference a b -> Reference a b
 referenceAvailableSince v (Reference m) =
     Reference (fmap (fieldDescAvailableSince v) m)
 
-referenceRemovedIn :: CabalSpecVersion -> Reference a b -> Reference a b
-referenceRemovedIn v (Reference m) =
-    Reference (fmap (fieldDescRemovedIn v) m)
+referenceRemovedIn :: CabalSpecVersion -> String -> Reference a b -> Reference a b
+referenceRemovedIn v desc (Reference m) =
+    Reference (fmap (fieldDescRemovedIn v desc) m)
 
-referenceDeprecatedSince :: CabalSpecVersion -> Reference a b -> Reference a b
-referenceDeprecatedSince v (Reference m) =
-    Reference (fmap (fieldDescDeprecatedSince v) m)
+referenceDeprecatedSince :: CabalSpecVersion -> String -> Reference a b -> Reference a b
+referenceDeprecatedSince v desc (Reference m) =
+    Reference (fmap (fieldDescDeprecatedSince v desc) m)
 
 (//) :: Reference a b -> Reference c d -> Reference a b
 Reference ab // Reference cd = Reference $ Map.difference ab cd
 
 fieldDescAvailableSince :: CabalSpecVersion -> FieldDesc -> FieldDesc
 fieldDescAvailableSince v d = d { fdAvailableSince = Just v }
 
-fieldDescRemovedIn :: CabalSpecVersion -> FieldDesc -> FieldDesc
-fieldDescRemovedIn v d = d { fdRemovedIn = Just v }
+fieldDescRemovedIn :: CabalSpecVersion -> String -> FieldDesc -> FieldDesc
+fieldDescRemovedIn v desc d = d { fdRemovedIn = Just (v, desc) }
 
-fieldDescDeprecatedSince :: CabalSpecVersion -> FieldDesc -> FieldDesc
-fieldDescDeprecatedSince v d = d { fdDeprecatedSince = Just v }
+fieldDescDeprecatedSince :: CabalSpecVersion -> String -> FieldDesc -> FieldDesc
+fieldDescDeprecatedSince v desc d = d { fdDeprecatedSince = Just (v, desc) }
 
 data FieldDesc = FieldDesc
     { fdAvailableSince  :: Maybe CabalSpecVersion
-    , fdRemovedIn       :: Maybe CabalSpecVersion
-    , fdDeprecatedSince :: Maybe CabalSpecVersion
+    , fdRemovedIn       :: Maybe (CabalSpecVersion, String)
+    , fdDeprecatedSince :: Maybe (CabalSpecVersion, String)
     , fdDescription     :: FieldDesc'
     }
   deriving Show
@@ -227,8 +230,8 @@ instance FieldGrammar Reference where
     -- hidden fields are hidden from the reference.
     hiddenField _ = Reference Map.empty
 
-    deprecatedSince v _ r = referenceDeprecatedSince v r
-    removedIn       v _ r = referenceRemovedIn v r
+    deprecatedSince = referenceDeprecatedSince
+    removedIn       = referenceRemovedIn
     availableSince  v _ r = referenceAvailableSince v r
 
 -------------------------------------------------------------------------------