Cherry-picked remaining commits from haddock-2.17.4-release (#603)

* Release haddock/haddock-api 2.17.4 and haddock-library 1.4.3

* Set version bounds for haddock-library

NB: This allows GHC 8.2.1's base

* Set version bounds for haddock & haddock-api

The version bounds support GHC 8.2

* Merge (temporary) v2.17.3 branch into v2.17

This allows us to delete the v2.17.3 branch

* Fixup changelog

* Pin down haddock-api to a single version

as otherwise `haddock`'s package version has no proper meaning

* fix source-repo spec for haddock-api

5 files changed, 48 insertions, 29 deletions

diff --git a/CHANGES b/CHANGES
index 4389c58a..7e3d052a 100644
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,17 @@
+Changes in version 2.17.4
+
+ * Fix 'internal error: links: UnhelpfulSpan' (#554, #565)
+
+ * Hyperlink backend knows about `DataKinds` (#510)
+
+ * Fix rendering of class methods for `Eq` and `Ord` (#549)
+
+ * Export `MDoc` and `toInstalledIface` from `Haddock.Types`
+
+Changes in version 2.17.3.1
+
+ * Disable `NFData` instances for GHC types when GHC >= 8.0.2 (#537)
+
 Changes in version 2.17.3
 
  * Remove framed view of the HTML documentation
diff --git a/haddock-api/haddock-api.cabal b/haddock-api/haddock-api.cabal
index 921e16eb..20b656b9 100644
--- a/haddock-api/haddock-api.cabal
+++ b/haddock-api/haddock-api.cabal
@@ -1,5 +1,5 @@
 name:                 haddock-api
-version:              2.17.3
+version:              2.17.4
 synopsis:             A documentation-generation tool for Haskell libraries
 description:          Haddock is a documentation-generation tool for Haskell
                       libraries
@@ -33,28 +33,29 @@ data-files:
   latex/haddock.sty
 
 library
-  default-language:
-      Haskell2010
+  default-language: Haskell2010
 
-  build-depends:
-      base >= 4.3 && < 4.11
-    , bytestring
-    , filepath
-    , directory
-    , containers
-    , transformers
-    , deepseq
-    , array
-    , xhtml >= 3000.2 && < 3000.3
-    , Cabal >= 1.10
-    , ghc-boot
-    , ghc == 8.2.*
+  -- this package typically supports only single major versions
+  build-depends: base            == 4.10.*
+               , Cabal           == 2.0.*
+               , ghc             == 8.2.*
+               , ghc-paths       == 0.1.*
+               , haddock-library >= 1.4.2 && < 1.5
+               , xhtml           == 3000.2.*
 
-    , ghc-paths
-    , haddock-library == 1.4.*
+  -- Versions for the dependencies below are transitively pinned by
+  -- the non-reinstallable `ghc` package and hence need no version
+  -- bounds
+  build-depends: array
+               , bytestring
+               , containers
+               , deepseq
+               , directory
+               , filepath
+               , ghc-boot
+               , transformers
 
-  hs-source-dirs:
-      src
+  hs-source-dirs: src
 
   ghc-options: -funbox-strict-fields -Wall -fwarn-tabs -O2
 
@@ -125,4 +126,5 @@ test-suite spec
 
 source-repository head
   type:     git
+  subdir:   haddock-api
   location: https://github.com/haskell/haddock.git
diff --git a/haddock-api/src/Haddock/Types.hs b/haddock-api/src/Haddock/Types.hs
index a6dd6354..803995cc 100644
--- a/haddock-api/src/Haddock/Types.hs
+++ b/haddock-api/src/Haddock/Types.hs
@@ -460,8 +460,8 @@ instance (NFData a, NFData mod)
     DocExamples a             -> a `deepseq` ()
     DocHeader a               -> a `deepseq` ()
 
-#if __GLASGOW_HASKELL__ < 801
--- These were added to GHC itself in 8.2.1
+#if !MIN_VERSION_ghc(8,0,2)
+-- These were added to GHC itself in 8.0.2
 instance NFData Name where rnf x = seq x ()
 instance NFData OccName where rnf x = seq x ()
 instance NFData ModuleName where rnf x = seq x ()
diff --git a/haddock-library/haddock-library.cabal b/haddock-library/haddock-library.cabal
index b7a20758..be433e6a 100644
--- a/haddock-library/haddock-library.cabal
+++ b/haddock-library/haddock-library.cabal
@@ -1,5 +1,5 @@
 name:                 haddock-library
-version:              1.4.2
+version:              1.4.3
 synopsis:             Library exposing some functionality of Haddock.
 description:          Haddock is a documentation-generation tool for Haskell
                       libraries. These modules expose some functionality of it
@@ -21,10 +21,10 @@ library
   default-language:     Haskell2010
 
   build-depends:
-      base >= 4.5 && < 4.11
-    , bytestring
-    , transformers
-    , deepseq
+      base         >= 4.5     && < 4.11
+    , bytestring   >= 0.9.2.1 && < 0.11
+    , transformers >= 0.3.0   && < 0.6
+    , deepseq      >= 1.3     && < 1.5
 
   hs-source-dirs:       src, vendor/attoparsec-0.12.1.1
   ghc-options:          -funbox-strict-fields -Wall -fwarn-tabs -O2
diff --git a/haddock.cabal b/haddock.cabal
index fa8a3531..598f2b9a 100644
--- a/haddock.cabal
+++ b/haddock.cabal
@@ -1,5 +1,5 @@
 name:                 haddock
-version:              2.17.3
+version:              2.17.4
 synopsis:             A documentation-generation tool for Haskell libraries
 description:          Haddock is a documentation-generation tool for Haskell
                       libraries
@@ -43,6 +43,7 @@ executable haddock
   hs-source-dirs:       driver
   ghc-options:          -funbox-strict-fields -Wall -fwarn-tabs -O2 -threaded
 
+  -- haddock typically only supports a single GHC major version
   build-depends:
     base >= 4.3 && < 4.11
   if flag(in-ghc-tree)
@@ -120,7 +121,9 @@ executable haddock
       Haddock.Syb
       Haddock.Convert
   else
-    build-depends:  haddock-api == 2.17.*
+    -- in order for haddock's advertised version number to have proper meaning,
+    -- we pin down to a single haddock-api version.
+    build-depends:  haddock-api == 2.17.4
 
 test-suite driver-test
   type:             exitcode-stdio-1.0