aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuchen Pei <hi@ypei.me>2022-07-21 11:08:15 +1000
committerYuchen Pei <hi@ypei.me>2022-07-21 11:08:15 +1000
commitcd17128898089450bb21790fd1864dc08fd4ddbc (patch)
treed6fdcab724b921bf331c2fac61aa22c3f0348337
parent7dace716b091cab0bcdf192a1c4749861dd15e62 (diff)
parent90c38242e54d1a742426e2b1b3c7d71e226811bd (diff)
Merge remote-tracking branch 'upstream/main'
-rw-r--r--.github/workflows/hlint-ci.yml2
-rw-r--r--.hlint.yaml13
-rw-r--r--CONTRIBUTING.md10
-rw-r--r--haddock-api/resources/html/package-lock.json64
-rw-r--r--haddock-api/src/Haddock.hs1
-rw-r--r--hoogle-test/src/Bug806/Bug806.hs1
-rw-r--r--html-test/src/BundledPatterns2.hs3
-rw-r--r--html-test/src/DefaultAssociatedTypes.hs2
-rw-r--r--html-test/src/GadtConstructorArgs.hs2
-rw-r--r--html-test/src/Operators.hs2
-rw-r--r--html-test/src/QuasiQuote.hs2
-rw-r--r--latex-test/src/GadtConstructorArgs/GadtConstructorArgs.hs2
12 files changed, 25 insertions, 79 deletions
diff --git a/.github/workflows/hlint-ci.yml b/.github/workflows/hlint-ci.yml
index 692d03e8..7009e739 100644
--- a/.github/workflows/hlint-ci.yml
+++ b/.github/workflows/hlint-ci.yml
@@ -17,7 +17,7 @@ jobs:
- uses: rwe/actions-hlint-setup@v1
name: Set up HLint
with:
- version: "3.3.6"
+ version: "3.4.1"
- uses: rwe/actions-hlint-run@v2
name: hlint
diff --git a/.hlint.yaml b/.hlint.yaml
index 5c50629f..4a0c8ddc 100644
--- a/.hlint.yaml
+++ b/.hlint.yaml
@@ -20,10 +20,9 @@
- ignore: {name: "Redundant return"} # 1 hint
- ignore: {name: "Replace case with fromMaybe"} # 2 hints
- ignore: {name: "Replace case with maybe"} # 4 hints
-- ignore: {name: "Unused LANGUAGE pragma"} # 10 hints
- ignore: {name: "Use $>"} # 4 hints
- ignore: {name: "Use ++"} # 3 hints
-- ignore: {name: "Use :"} # 3 hints
+- ignore: {name: "Use :"} # 4 hints
- ignore: {name: "Use <$>"} # 12 hints
- ignore: {name: "Use <&>"} # 1 hint
- ignore: {name: "Use <|>"} # 1 hint
@@ -34,12 +33,11 @@
- ignore: {name: "Use concatMap"} # 1 hint
- ignore: {name: "Use const"} # 4 hints
- ignore: {name: "Use fewer LANGUAGE pragmas"} # 1 hint
-- ignore: {name: "Use fewer imports"} # 1 hint
- ignore: {name: "Use find"} # 1 hint
- ignore: {name: "Use fmap"} # 12 hints
- ignore: {name: "Use foldr"} # 1 hint
- ignore: {name: "Use fromMaybe"} # 2 hints
-- ignore: {name: "Use infix"} # 2 hints
+- ignore: {name: "Use infix"} # 3 hints
- ignore: {name: "Use intercalate"} # 1 hint
- ignore: {name: "Use isAsciiLower"} # 1 hint
- ignore: {name: "Use isAsciiUpper"} # 1 hint
@@ -54,11 +52,14 @@
- ignore: {name: "Use notElem"} # 2 hints
- ignore: {name: "Use print"} # 3 hints
- ignore: {name: "Use record patterns"} # 5 hints
+- ignore: {name: "Use second"} # 3 hints
- ignore: {name: "Use sortOn"} # 3 hints
-- ignore: {name: "Use tuple-section"} # 2 hints
+- ignore: {name: "Use tuple-section"} # 3 hints
- ignore: {name: "Use unless"} # 1 hint
- ignore: {name: "Use void"} # 1 hint
-- ignore: {name: "Use second"} # 3 hints
+# Ignore within modules where following hlint or adding an HLint annotation
+# would alter the expected test output.
+- ignore: {name: "Unused LANGUAGE pragma", within: [QuasiExpr, TH, Ticket112]}
# Module names (not all unique) where CPP can be used
- extensions:
- name: CPP
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 25b7a002..4435252a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -36,16 +36,13 @@ cd haddock
### Git Branches
-For improvements to the documentation generator,
-please base your pull request on the latest GHC version branch
-(`ghc-9.2` for instance).
+Pull requests are to be opened against the `main` branch, from which are forked
+GHC-specific branches (like `ghc-9.2`, `ghc-9.4`, etc).
### Building the packages
#### Using `cabal`
-Requires cabal `>= 3.4` and GHC `== 9.2`:
-
First update the package list:
```bash
@@ -60,7 +57,7 @@ cabal v2-build all --enable-tests
cabal v2-test all
```
-### Updating golden testsuite outputs
+### Updating golden test suite outputs
If you've changed Haddock's output, you will probably need to accept the new
output of Haddock's golden test suites (`html-test`, `latex-test`,
@@ -72,6 +69,5 @@ cabal v2-test html-test latex-test hoogle-test hypsrc-test \
--test-option='--accept'
```
-
[SSCCE]: http://sscce.org/
[CoC]: ./CODE_OF_CONDUCT.md
diff --git a/haddock-api/resources/html/package-lock.json b/haddock-api/resources/html/package-lock.json
index 638b5dd8..cd63cad8 100644
--- a/haddock-api/resources/html/package-lock.json
+++ b/haddock-api/resources/html/package-lock.json
@@ -247,12 +247,6 @@
"node": ">=0.10.0"
}
},
- "node_modules/array-filter": {
- "version": "0.0.1",
- "resolved": "https://registry.npmjs.org/array-filter/-/array-filter-0.0.1.tgz",
- "integrity": "sha1-fajPLiZijtcygDWB/SH2fKzS7uw=",
- "dev": true
- },
"node_modules/array-initial": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/array-initial/-/array-initial-1.1.0.tgz",
@@ -296,18 +290,6 @@
"node": ">=0.10.0"
}
},
- "node_modules/array-map": {
- "version": "0.0.0",
- "resolved": "https://registry.npmjs.org/array-map/-/array-map-0.0.0.tgz",
- "integrity": "sha1-iKK6tz0c97zVwbEYoAP2b2ZfpmI=",
- "dev": true
- },
- "node_modules/array-reduce": {
- "version": "0.0.0",
- "resolved": "https://registry.npmjs.org/array-reduce/-/array-reduce-0.0.0.tgz",
- "integrity": "sha1-FziZ0//Rx9k4PkR5Ul2+J4yrXys=",
- "dev": true
- },
"node_modules/array-slice": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/array-slice/-/array-slice-1.1.0.tgz",
@@ -4386,16 +4368,10 @@
}
},
"node_modules/shell-quote": {
- "version": "1.6.1",
- "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.6.1.tgz",
- "integrity": "sha1-9HgZSczkAmlxJ0MOo7PFR29IF2c=",
- "dev": true,
- "dependencies": {
- "array-filter": "~0.0.0",
- "array-map": "~0.0.0",
- "array-reduce": "~0.0.0",
- "jsonify": "~0.0.0"
- }
+ "version": "1.7.3",
+ "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.7.3.tgz",
+ "integrity": "sha512-Vpfqwm4EnqGdlsBFNmHhxhElJYrdfcxPThu+ryKS5J8L/fhAwLazFZtq+S+TWZ9ANj2piSQLGj6NQg+lKPmxrw==",
+ "dev": true
},
"node_modules/simple-concat": {
"version": "1.0.0",
@@ -5810,12 +5786,6 @@
"integrity": "sha512-zHjL5SZa68hkKHBFBK6DJCTtr9sfTCPCaph/L7tMSLcTFgy+zX7E+6q5UArbtOtMBCtxdICpfTCspRse+ywyXA==",
"dev": true
},
- "array-filter": {
- "version": "0.0.1",
- "resolved": "https://registry.npmjs.org/array-filter/-/array-filter-0.0.1.tgz",
- "integrity": "sha1-fajPLiZijtcygDWB/SH2fKzS7uw=",
- "dev": true
- },
"array-initial": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/array-initial/-/array-initial-1.1.0.tgz",
@@ -5851,18 +5821,6 @@
}
}
},
- "array-map": {
- "version": "0.0.0",
- "resolved": "https://registry.npmjs.org/array-map/-/array-map-0.0.0.tgz",
- "integrity": "sha1-iKK6tz0c97zVwbEYoAP2b2ZfpmI=",
- "dev": true
- },
- "array-reduce": {
- "version": "0.0.0",
- "resolved": "https://registry.npmjs.org/array-reduce/-/array-reduce-0.0.0.tgz",
- "integrity": "sha1-FziZ0//Rx9k4PkR5Ul2+J4yrXys=",
- "dev": true
- },
"array-slice": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/array-slice/-/array-slice-1.1.0.tgz",
@@ -9329,16 +9287,10 @@
}
},
"shell-quote": {
- "version": "1.6.1",
- "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.6.1.tgz",
- "integrity": "sha1-9HgZSczkAmlxJ0MOo7PFR29IF2c=",
- "dev": true,
- "requires": {
- "array-filter": "~0.0.0",
- "array-map": "~0.0.0",
- "array-reduce": "~0.0.0",
- "jsonify": "~0.0.0"
- }
+ "version": "1.7.3",
+ "resolved": "https://registry.npmjs.org/shell-quote/-/shell-quote-1.7.3.tgz",
+ "integrity": "sha512-Vpfqwm4EnqGdlsBFNmHhxhElJYrdfcxPThu+ryKS5J8L/fhAwLazFZtq+S+TWZ9ANj2piSQLGj6NQg+lKPmxrw==",
+ "dev": true
},
"simple-concat": {
"version": "1.0.0",
diff --git a/haddock-api/src/Haddock.hs b/haddock-api/src/Haddock.hs
index 4176338e..65d329e2 100644
--- a/haddock-api/src/Haddock.hs
+++ b/haddock-api/src/Haddock.hs
@@ -4,7 +4,6 @@
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE Rank2Types #-}
{-# LANGUAGE ScopedTypeVariables #-}
-{-# LANGUAGE TupleSections #-}
{-# OPTIONS_GHC -Wwarn #-}
-----------------------------------------------------------------------------
-- |
diff --git a/hoogle-test/src/Bug806/Bug806.hs b/hoogle-test/src/Bug806/Bug806.hs
index 6deb98c1..f2a9a099 100644
--- a/hoogle-test/src/Bug806/Bug806.hs
+++ b/hoogle-test/src/Bug806/Bug806.hs
@@ -1,5 +1,4 @@
{-# LANGUAGE Haskell2010 #-}
-{-# LANGUAGE KindSignatures #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE UndecidableInstances #-}
module Bug806 where
diff --git a/html-test/src/BundledPatterns2.hs b/html-test/src/BundledPatterns2.hs
index c4123535..6f1b61f5 100644
--- a/html-test/src/BundledPatterns2.hs
+++ b/html-test/src/BundledPatterns2.hs
@@ -1,6 +1,5 @@
{-# LANGUAGE Haskell2010 #-}
-{-# LANGUAGE DataKinds, GADTs, KindSignatures, PatternSynonyms, TypeOperators,
- ViewPatterns #-}
+{-# LANGUAGE DataKinds, GADTs, KindSignatures, PatternSynonyms #-}
module BundledPatterns2 (Vec((:>), Empty), RTree(..)) where
import GHC.TypeLits
diff --git a/html-test/src/DefaultAssociatedTypes.hs b/html-test/src/DefaultAssociatedTypes.hs
index 340742d3..68a587ef 100644
--- a/html-test/src/DefaultAssociatedTypes.hs
+++ b/html-test/src/DefaultAssociatedTypes.hs
@@ -1,5 +1,5 @@
{-# LANGUAGE Haskell2010 #-}
-{-# LANGUAGE DefaultSignatures, TypeFamilies #-}
+{-# LANGUAGE TypeFamilies #-}
module DefaultAssociatedTypes where
diff --git a/html-test/src/GadtConstructorArgs.hs b/html-test/src/GadtConstructorArgs.hs
index 6d742bd7..50ff93cc 100644
--- a/html-test/src/GadtConstructorArgs.hs
+++ b/html-test/src/GadtConstructorArgs.hs
@@ -1,5 +1,5 @@
{-# LANGUAGE Haskell2010 #-}
-{-# LANGUAGE GADTs, PatternSynonyms #-}
+{-# LANGUAGE GADTs #-}
module GadtConstructorArgs (Boo(..)) where
diff --git a/html-test/src/Operators.hs b/html-test/src/Operators.hs
index c303c8bd..1d938ba6 100644
--- a/html-test/src/Operators.hs
+++ b/html-test/src/Operators.hs
@@ -1,5 +1,5 @@
{-# LANGUAGE Haskell2010 #-}
-{-# LANGUAGE PatternSynonyms, TypeOperators, TypeFamilies, MultiParamTypeClasses, GADTs #-}
+{-# LANGUAGE PatternSynonyms, TypeOperators, TypeFamilies, GADTs #-}
{-# LANGUAGE FunctionalDependencies #-}
-- | Test operators with or without fixity declarations
diff --git a/html-test/src/QuasiQuote.hs b/html-test/src/QuasiQuote.hs
index fe900eb8..6cc928cd 100644
--- a/html-test/src/QuasiQuote.hs
+++ b/html-test/src/QuasiQuote.hs
@@ -1,5 +1,5 @@
{-# LANGUAGE Haskell2010 #-}
-{-# LANGUAGE TemplateHaskell, QuasiQuotes #-}
+{-# LANGUAGE QuasiQuotes #-}
-- example taken from the GHC documentation
module QuasiQuote where
diff --git a/latex-test/src/GadtConstructorArgs/GadtConstructorArgs.hs b/latex-test/src/GadtConstructorArgs/GadtConstructorArgs.hs
index 6d742bd7..50ff93cc 100644
--- a/latex-test/src/GadtConstructorArgs/GadtConstructorArgs.hs
+++ b/latex-test/src/GadtConstructorArgs/GadtConstructorArgs.hs
@@ -1,5 +1,5 @@
{-# LANGUAGE Haskell2010 #-}
-{-# LANGUAGE GADTs, PatternSynonyms #-}
+{-# LANGUAGE GADTs #-}
module GadtConstructorArgs (Boo(..)) where