Update .cabal file & convert changelog to markdown
authorHerbert Valerio Riedel <hvr@gnu.org>
Sat, 30 Dec 2017 10:16:42 +0000 (11:16 +0100)
committerHerbert Valerio Riedel <hvr@gnu.org>
Sat, 30 Dec 2017 10:16:42 +0000 (11:16 +0100)
ChangeLog.md [moved from CHANGES with 70% similarity]
README.md
parsec.cabal

similarity index 70%
rename from CHANGES
rename to ChangeLog.md
index 7bad8cd..d7e983a 100644 (file)
--- a/CHANGES
@@ -1,12 +1,12 @@
-3.1.12
+### 3.1.12.0
 
 - Add `MonadFail` instance for `ParsecT`
 
-3.1.11
+### 3.1.11
 
 - Include `README.md` in package.
 
-3.1.10
+### 3.1.10
 
 - Most types now have a `Typeable` instance. Some instances are dropped from
   older versions of GHC (sorry about that!).
 - Documentation fixes and corrections.
 - We no longer test parsec builds on GHC 7.4.
 
-3.1.9
+### 3.1.9
 
 - Many and various updates to documentation and package description (inlcuding
   the homepage links).
-- Add an 'Eq' instance for 'ParseError'
-- Fixed a regression from 3.1.6: 'runP' is again exported from module
+- Add an `Eq` instance for `ParseError`
+- Fixed a regression from 3.1.6: `runP` is again exported from module
   Text.Parsec.
 
-3.1.8
+### 3.1.8
 
 - Fix a regression from 3.1.6 related to exports from the main module.
 
-3.1.7
+### 3.1.7
 
 - Fix a regression from 3.1.6 related to the reported position of error messages.
   See bug #9 for details.
-- Reset the current error position on success of 'lookAhead'.
+- Reset the current error position on success of `lookAhead`.
 
-3.1.6
+### 3.1.6
 
-- Export 'Text' instances from Text.Parsec
+- Export `Text` instances from Text.Parsec
 - Make Text.Parsec exports more visible
 - Re-arrange Text.Parsec exports
-- Add functions 'crlf' and 'endOfLine' to Text.Parsec.Char for handling
+- Add functions `crlf` and `endOfLine` to Text.Parsec.Char for handling
   input streams that do not have normalized line terminators.
 - Fix off-by-one error in Token.charControl
 
-3.1.4 & 3.1.5
+### 3.1.4
 
-- Bump dependency on 'text'
+- Relax dependency on `text`
 
-3.1.3
+### 3.1.5
+
+- Relax dependency on `text`
+
+### 3.1.3
 
 - Fix a regression introduced in 3.1.2 related to positions reported by error messages.
index 50e71c2..887214f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
 Parsec [![Build Status](https://travis-ci.org/haskell/parsec.svg?branch=master)](https://travis-ci.org/haskell/parsec)
 ======
 
+**Please refer to the [package description on Hackage](https://hackage.haskell.org/package/parsec#description) for more information.**
+
 A monadic parser combinator library, written by Daan Leijen. Parsec is designed
 from scratch as an industrial-strength parser library. It is simple, safe, well
 documented, has extensive libraries, good error messages, and is fast.
index 183ce7f..4d0411d 100644 (file)
@@ -1,24 +1,27 @@
-name:          parsec
-version:       3.1.12
-cabal-version: >= 1.10
-license:       BSD3
-license-file:  LICENSE
-author:                Daan Leijen <daan@microsoft.com>, Paolo Martini <paolo@nemail.it>
-maintainer:    Antoine Latter <aslatter@gmail.com>
-homepage:      https://github.com/haskell/parsec
+cabal-version:  >= 1.10
+name:           parsec
+version:        3.1.12.0
+
+synopsis:       Monadic parser combinators
+description:    Parsec is designed from scratch as an industrial-strength parser
+                library.  It is simple, safe, well documented (on the package
+                homepage), has extensive libraries, good error messages,
+                and is fast.  It is defined as a monad transformer that can be
+                stacked on arbitrary monads, and it is also parametric in the
+                input stream type.
+
+license:        BSD3
+license-file:   LICENSE
+author:         Daan Leijen <daan@microsoft.com>, Paolo Martini <paolo@nemail.it>, Antoine Latter <aslatter@gmail.com>
+maintainer:     Herbert Valerio Riedel <hvr@gnu.org>
+homepage:       https://github.com/haskell/parsec
 bug-reports:    https://github.com/haskell/parsec/issues
-category:      Parsing
-synopsis:      Monadic parser combinators
+category:       Parsing
+
 build-type:     Simple
-description:
-       Parsec is designed from scratch as an industrial-strength parser
-       library.  It is simple, safe, well documented (on the package
-       homepage), has extensive libraries, good error messages,
-       and is fast.  It is defined as a monad transformer that can be
-       stacked on arbitrary monads, and it is also parametric in the
-       input stream type.
-extra-source-files: CHANGES, README.md
-tested-with: GHC==8.2.1, GHC==8.0.2, GHC==7.10.3, GHC==7.8.4, GHC==7.6.3, GHC==7.4.2, GHC==7.2.2, GHC==7.0.4
+tested-with:    GHC ==8.2.2 || ==8.0.2 || ==7.10.3 || ==7.8.4 || ==7.6.3 || ==7.4.2 || ==7.2.2 || ==7.0.4
+
+extra-source-files: ChangeLog.md, README.md
 
 source-repository head
     type: git
@@ -26,75 +29,79 @@ source-repository head
 
 library
     exposed-modules:
-        Text.Parsec,
-        Text.Parsec.String,
-        Text.Parsec.ByteString,
-        Text.Parsec.ByteString.Lazy,
-        Text.Parsec.Text,
-        Text.Parsec.Text.Lazy,
-        Text.Parsec.Pos,
-        Text.Parsec.Error,
-        Text.Parsec.Prim,
-        Text.Parsec.Char,
-        Text.Parsec.Combinator,
-        Text.Parsec.Token,
-        Text.Parsec.Expr,
-        Text.Parsec.Language,
-        Text.Parsec.Perm,
-        Text.ParserCombinators.Parsec,
-        Text.ParserCombinators.Parsec.Char,
-        Text.ParserCombinators.Parsec.Combinator,
-        Text.ParserCombinators.Parsec.Error,
-        Text.ParserCombinators.Parsec.Expr,
-        Text.ParserCombinators.Parsec.Language,
-        Text.ParserCombinators.Parsec.Perm,
-        Text.ParserCombinators.Parsec.Pos,
-        Text.ParserCombinators.Parsec.Prim,
+        Text.Parsec
+        Text.Parsec.String
+        Text.Parsec.ByteString
+        Text.Parsec.ByteString.Lazy
+        Text.Parsec.Text
+        Text.Parsec.Text.Lazy
+        Text.Parsec.Pos
+        Text.Parsec.Error
+        Text.Parsec.Prim
+        Text.Parsec.Char
+        Text.Parsec.Combinator
+        Text.Parsec.Token
+        Text.Parsec.Expr
+        Text.Parsec.Language
+        Text.Parsec.Perm
+        Text.ParserCombinators.Parsec
+        Text.ParserCombinators.Parsec.Char
+        Text.ParserCombinators.Parsec.Combinator
+        Text.ParserCombinators.Parsec.Error
+        Text.ParserCombinators.Parsec.Expr
+        Text.ParserCombinators.Parsec.Language
+        Text.ParserCombinators.Parsec.Perm
+        Text.ParserCombinators.Parsec.Pos
+        Text.ParserCombinators.Parsec.Prim
         Text.ParserCombinators.Parsec.Token
 
     build-depends:
-       base >= 4 && < 5,
-       mtl,
-       bytestring,
-       text >= 0.2 && < 1.3
+        base       >= 4.3   && < 5,
+        mtl        >= 1.1   && < 2.3,
+        bytestring >= 0.9.1 && < 0.11,
+        text       >= 0.2   && < 1.3
 
     default-language: Haskell2010
     other-extensions:
-       CPP
-       DeriveDataTypeable
-       ExistentialQuantification
-       FlexibleContexts
-       FlexibleInstances
-       FunctionalDependencies
-       MultiParamTypeClasses
-       PolymorphicComponents
-       StandaloneDeriving
-       UndecidableInstances
+        CPP
+        DeriveDataTypeable
+        ExistentialQuantification
+        FlexibleContexts
+        FlexibleInstances
+        FunctionalDependencies
+        MultiParamTypeClasses
+        PolymorphicComponents
+        StandaloneDeriving
+        UndecidableInstances
 
     ghc-options: -Wall
     if impl(ghc >= 8.0)
-       ghc-options: -Wcompat -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances
+        ghc-options: -Wcompat -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances
     else
-       -- provide/emulate `Control.Monad.Fail` API for pre-GHC8
-       build-depends: fail == 4.9.*
+        -- provide/emulate `Control.Monad.Fail` API for pre-GHC8
+        build-depends: fail == 4.9.*
 
-
-Test-Suite tests
+test-suite parsec
     default-language: Haskell2010
     type:        exitcode-stdio-1.0
     hs-source-dirs:  test
     main-is:     Main.hs
     other-modules:
-                 Bugs,
-                 Bugs.Bug2,
-                 Bugs.Bug6,
-                 Bugs.Bug9,
-                 Bugs.Bug35,
-                 Util
+        Bugs
+        Bugs.Bug2
+        Bugs.Bug6
+        Bugs.Bug9
+        Bugs.Bug35
+        Util
+
     build-depends:
-       base,
-       parsec,
-       HUnit >= 1.2 && < 1.4,
-       test-framework >= 0.6 && < 0.9,
-       test-framework-hunit >= 0.2 && < 0.4
+        base,
+        parsec,
+        -- dependencies whose version bounds are not inherited via lib:parsec
+        HUnit                >= 1.2 && < 1.4,
+        test-framework       >= 0.6 && < 0.9,
+        test-framework-hunit >= 0.2 && < 0.4
+
     ghc-options: -Wall
+    if impl(ghc >= 8.0)
+        ghc-options: -Wcompat -Wnoncanonical-monad-instances -Wnoncanonical-monadfail-instances