Merge branch 'master' into m-renaud-mrenaud-docs-getting-started

.github/mergify.yml

@@ -0,0 +1,29 @@
+pull_request_rules:
+  # rebase+merge strategy
+  - actions:
+      queue:
+        name: default
+        # Merge into master with a merge commit
+        method: merge
+        # Update the pr branch with rebase, so the history is clean
+        update_method: rebase
+    name: Put pull requests in the rebase+merge queue
+    conditions:
+      - label=merge me
+      - '#approved-reviews-by>=2'
+  # merge+squash strategy
+  - actions:
+      queue:
+        name: default
+        method: squash
+        # both update methods get absorbed by the squash, so we use the most
+        # reliable
+        update_method: merge
+    name: Put pull requests in the squash+merge queue
+    conditions:
+      - label=squash+merge me
+      - '#approved-reviews-by>=2'
+
+queue_rules:
+  - name: default
+    conditions: []

.github/workflows/windows.yml

@@ -63,7 +63,7 @@ jobs:
           cabal v2-run cabal-install:unit-tests -- --pattern "! (/FileMonitor/ || /VCS/ || /Get/)"
       - name: cabal-tests
         # Using only one job, -j1, to fail less.
-        run: cabal v2-run cabal-testsuite:cabal-tests -- -j1 --with-cabal=dist-newstyle\build\x86_64-windows\ghc-8.6.5\cabal-install-3.6.0.0\x\cabal\build\cabal\cabal.exe
+        run: cabal v2-run cabal-testsuite:cabal-tests -- -j1 --with-cabal=dist-newstyle\build\x86_64-windows\ghc-8.6.5\cabal-install-3.7.0.0\x\cabal\build\cabal\cabal.exe
   test-windows-8_10_4:
     name: test ghc-8.10.4
     runs-on: windows-latest
@@ -111,4 +111,4 @@ jobs:
           cabal v2-run cabal-install:unit-tests -- --pattern "! (/FileMonitor/ || /VCS/ || /Get/)"
       - name: cabal-tests
         # Using only one job, -j1, to fail less.
-        run: cabal v2-run cabal-testsuite:cabal-tests -- -j1 --with-cabal=dist-newstyle\build\x86_64-windows\ghc-8.10.4\cabal-install-3.6.0.0\x\cabal\build\cabal\cabal.exe
+        run: cabal v2-run cabal-testsuite:cabal-tests -- -j1 --with-cabal=dist-newstyle\build\x86_64-windows\ghc-8.10.4\cabal-install-3.7.0.0\x\cabal\build\cabal\cabal.exe

.gitignore

@@ -26,6 +26,11 @@ cabal-tests.log
 /cabal-install/Setup
 /cabal-install/source-file-list
 
+.stylish-haskell.yaml
+.stylish-haskell.yml
+.ghci
+.ghcid
+
 # Output of release and bootstrap
 _build
 
@@ -69,3 +74,6 @@ register.sh
 
 # benchmarks
 bench.html
+
+# Emacs
+.projectile

CONTRIBUTING.md

@@ -29,11 +29,11 @@ cabal v2-build cabal-tests # etc...
 Running tests
 -------------
 
-**Using Github Actions and AppVeyor.**
+**Using Github Actions.**
 If you are not in a hurry, the most convenient way to run tests on Cabal
 is to make a branch on GitHub and then open a pull request; our
-continuous integration service on Github Actions and AppVeyor will build and
-test your code.  Title your PR with WIP so we know that it does not need
+continuous integration service on Github Actions builds and
+tests your code.  Title your PR with WIP so we know that it does not need
 code review.
 
 Some tips for using Github Actions effectively:
@@ -72,10 +72,6 @@ failures:
    tested.  If you have an Ubuntu system, you can download
    the binaries and run them directly.
 
-5. Is the test failing on AppVeyor?  Consider logging in via
-   Remote Desktop to the build VM:
-   https://www.appveyor.com/docs/how-to/rdp-to-build-worker/
-
 If none of these let you reproduce, there might be some race condition
 or continuous integration breakage; please file a bug.
 
@@ -194,8 +190,9 @@ We like [this style guide][guide].
 Changelog
 ---------
 
-When opening a pull request, you should write a changelog entry.
-This is done by adding a file in the `changelog.d` directory.
+When opening a pull request, you should write a changelog entry
+(or more in case of multiple independent changes).
+This is done by adding files in the `changelog.d` directory.
 
 The files follow a simple key-value format similar to the one for .cabal files.
 

Cabal-QuickCheck/Cabal-QuickCheck.cabal

@@ -1,6 +1,6 @@
 cabal-version: 2.2
 name:          Cabal-QuickCheck
-version:       3.6.0.0
+version:       3.7.0.0
 synopsis:      QuickCheck instances for types in Cabal
 category:      Testing
 description:
@@ -13,7 +13,7 @@ library
   build-depends:
     , base
     , bytestring
-    , Cabal       ^>=3.6.0.0
+    , Cabal       ^>=3.7.0.0
     , QuickCheck  ^>=2.13.2 || ^>=2.14
 
   if !impl(ghc >= 8.0)

Cabal-described/Cabal-described.cabal

@@ -1,6 +1,6 @@
 cabal-version: 2.2
 name:          Cabal-described
-version:       3.6.0.0
+version:       3.7.0.0
 synopsis:      Described functionality for types in Cabal
 category:      Testing, Parsec
 description:   Provides rere bindings
@@ -11,7 +11,7 @@ library
   ghc-options:      -Wall
   build-depends:
     , base
-    , Cabal             ^>=3.6.0.0
+    , Cabal             ^>=3.7.0.0
     , containers
     , pretty
     , QuickCheck

Cabal-tests/Cabal-tests.cabal

@@ -31,6 +31,7 @@ test-suite unit-tests
     UnitTests.Distribution.Compat.Time
     UnitTests.Distribution.Described
     UnitTests.Distribution.PkgconfigVersion
+    UnitTests.Distribution.Simple.Command
     UnitTests.Distribution.Simple.Glob
     UnitTests.Distribution.Simple.Program.GHC
     UnitTests.Distribution.Simple.Program.Internal
@@ -40,6 +41,7 @@ test-suite unit-tests
     UnitTests.Distribution.Types.GenericPackageDescription
     UnitTests.Distribution.Utils.CharSet
     UnitTests.Distribution.Utils.Generic
+    UnitTests.Distribution.Utils.Json
     UnitTests.Distribution.Utils.NubList
     UnitTests.Distribution.Utils.ShortText
     UnitTests.Distribution.Utils.Structured
@@ -150,7 +152,6 @@ test-suite hackage-tests
   type:               exitcode-stdio-1.0
   main-is:            HackageTests.hs
 
-  -- TODO: need to get 01-index.tar on appveyor
   if os(windows)
     buildable: False
 

Cabal-tests/tests/ParserTests/ipi/Includes2.expr

@@ -1,58 +1,92 @@
-InstalledPackageInfo
-  {abiDepends = [AbiDependency
-                   {depAbiHash = AbiHash "35a7f6be752ee4f7385cb5bf28677879",
-                    depUnitId = UnitId "base-4.10.1.0"},
-                 AbiDependency
-                   {depAbiHash = AbiHash "inplace",
-                    depUnitId = UnitId "Includes2-0.1.0.0-inplace-mysql"}],
-   abiHash = AbiHash "inplace",
-   author = "Edward Z. Yang",
-   category = "",
-   ccOptions = [],
-   compatPackageKey = "Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n",
-   copyright = "",
-   cxxOptions = [],
-   dataDir = "/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2",
-   depends = [UnitId "base-4.10.1.0",
-              UnitId "Includes2-0.1.0.0-inplace-mysql"],
-   description = "",
-   exposed = False,
-   exposedModules = [ExposedModule
-                       {exposedName = ModuleName "Mine", exposedReexport = Nothing}],
-   extraGHCiLibraries = [],
-   extraLibraries = [],
-   frameworkDirs = [],
-   frameworks = [],
-   haddockHTMLs = ["/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/doc/html/Includes2"],
-   haddockInterfaces = ["/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/doc/html/Includes2/Includes2.haddock"],
-   hiddenModules = [],
-   homepage = "",
-   hsLibraries = ["HSIncludes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n"],
-   importDirs = ["/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/build/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n"],
-   includeDirs = [],
-   includes = [],
-   indefinite = False,
-   installedComponentId_ = ComponentId "",
-   installedUnitId = UnitId
-                       "Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n",
-   instantiatedWith = [_×_
-                         (ModuleName "Database")
-                         (OpenModule
-                            (DefiniteUnitId
-                               (DefUnitId (UnitId "Includes2-0.1.0.0-inplace-mysql")))
-                            (ModuleName "Database.MySQL"))],
-   ldOptions = [],
-   libVisibility = LibraryVisibilityPrivate,
-   libraryDirs = ["/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/build/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n"],
-   libraryDynDirs = ["/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/build/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n"],
-   license = Right BSD3,
-   maintainer = "ezyang@cs.stanford.edu",
-   pkgRoot = Nothing,
-   pkgUrl = "",
-   sourceLibName = LSubLibName (UnqualComponentName "mylib"),
-   sourcePackageId = PackageIdentifier
-                       {pkgName = PackageName "Includes2",
-                        pkgVersion = mkVersion [0, 1, 0, 0]},
-   stability = "",
-   synopsis = "",
-   trusted = False}
+InstalledPackageInfo {
+  sourcePackageId =
+  PackageIdentifier {
+    pkgName = PackageName
+      "Includes2",
+    pkgVersion = mkVersion
+      [0, 1, 0, 0]},
+  sourceLibName = LSubLibName
+    (UnqualComponentName "mylib"),
+  installedComponentId_ =
+  ComponentId "",
+  libVisibility =
+  LibraryVisibilityPrivate,
+  installedUnitId = UnitId
+    "Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n",
+  instantiatedWith = [
+    _×_
+      (ModuleName "Database")
+      (OpenModule
+        (DefiniteUnitId
+          (DefUnitId
+            (UnitId
+              "Includes2-0.1.0.0-inplace-mysql")))
+        (ModuleName "Database.MySQL"))],
+  compatPackageKey =
+  "Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n",
+  license = Right BSD3,
+  copyright = "",
+  maintainer =
+  "ezyang@cs.stanford.edu",
+  author = "Edward Z. Yang",
+  stability = "",
+  homepage = "",
+  pkgUrl = "",
+  synopsis = "",
+  description = "",
+  category = "",
+  abiHash = AbiHash "inplace",
+  indefinite = False,
+  exposed = False,
+  exposedModules = [
+    ExposedModule {
+      exposedName = ModuleName "Mine",
+      exposedReexport = Nothing}],
+  hiddenModules = [],
+  trusted = False,
+  importDirs =
+  [
+    "/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/build/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n"],
+  libraryDirs =
+  [
+    "/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/build/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n"],
+  libraryDirsStatic = [],
+  libraryDynDirs =
+  [
+    "/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/build/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n"],
+  dataDir =
+  "/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2",
+  hsLibraries = [
+    "HSIncludes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n"],
+  extraLibraries = [],
+  extraLibrariesStatic = [],
+  extraGHCiLibraries = [],
+  includeDirs = [],
+  includes = [],
+  depends = [
+    UnitId "base-4.10.1.0",
+    UnitId
+      "Includes2-0.1.0.0-inplace-mysql"],
+  abiDepends = [
+    AbiDependency {
+      depUnitId = UnitId
+        "base-4.10.1.0",
+      depAbiHash = AbiHash
+        "35a7f6be752ee4f7385cb5bf28677879"},
+    AbiDependency {
+      depUnitId = UnitId
+        "Includes2-0.1.0.0-inplace-mysql",
+      depAbiHash = AbiHash
+        "inplace"}],
+  ccOptions = [],
+  cxxOptions = [],
+  ldOptions = [],
+  frameworkDirs = [],
+  frameworks = [],
+  haddockInterfaces =
+  [
+    "/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/doc/html/Includes2/Includes2.haddock"],
+  haddockHTMLs =
+  [
+    "/home/travis/build/haskell/cabal/cabal-testsuite/PackageTests/Backpack/Includes2/cabal-internal.dist/work/./dist/build/x86_64-linux/ghc-8.2.2/Includes2-0.1.0.0/l/mylib/Includes2-0.1.0.0-inplace-mylib+3gY9SyjX86dBypHcOaev1n/doc/html/Includes2"],
+  pkgRoot = Nothing}