WIP

haskell · Jul 10, 2020 · 3496228 · 3496228
1 parent d5eba37
commit 3496228
Show file tree

Hide file tree

Showing 50 changed files with 216 additions and 150 deletions.
diff --git a/changelog.d/Cabal-QuickCheck b/changelog.d/Cabal-QuickCheck
@@ -1,2 +1,4 @@
-synopsis: Cabal-QuickCheck package
-prs: #6557
+synopsis: Cabal-QuickCheck package with Arbirary instances
+prs: #6557 #6891
+issues: #6882
+packages: Cabal
diff --git a/changelog.d/Cabal-tree-diff b/changelog.d/Cabal-tree-diff
@@ -1,2 +1,3 @@
-synopsis: Create Cabal-tree-diff package
+synopsis: Create Cabal-tree-diff package with ToExpr instances
 prs: #6789
+packages: Cabal
diff --git a/changelog.d/active-repositories b/changelog.d/active-repositories
@@ -2,3 +2,13 @@ synopsis: Add active-repositories configuration
 packages: cabal-install
 prs: #6724 #6868
 issues: #6819
+significance: significant
+
+description: {
+
+New `active-repositories` `cabal.project` fields allows
+specifying an order and ways various package repositories are combined.
+
+The active `active-repositories` is saved in `cabal.project.freeze`.
+
+}
diff --git a/changelog.d/cabal-init b/changelog.d/cabal-init
@@ -1,15 +1,21 @@
 synopsis: Various `cabal init` improvements
 packages: cabal-install
-prs: #6619 #6661 #6641 #6650 #6603 #6632 #6607 #6678 #6690 #6705 #6723
+prs: #6619 #6661 #6641 #6650 #6603 #6632 #6607 #6678 #6690 #6705 #6723 #6676 #6677
+issues: #6150 #6675
+significance: significant
 
 description: {
+
 - Default to `cabal-version: 2.4`
 - `cabal` doesn't force a default license choice anymore
 - Licenses are always asked using SPDX expression
 - Fix an infinite loop when invalid license was passed on command line
 - `Setup.hs` is not written anymore
 - Default to --source-dir=src and --application-dir=app
 - Add FileCreators.generateCabalFile unit tests.
+- Default cabal init application-dir to app, and source-dir to src.
+- Default to SPDX.NONE license in cabal init interactive mode.
 
 TODO: complete the description
+
 }
diff --git a/changelog.d/cabal-list b/changelog.d/cabal-list
@@ -0,0 +1,5 @@
+synopsis: `cabal list` accepts regular expression
+packages: cabal-install
+prs: #6618 #6806
+issues: #4267 #6683
+significance: significant
diff --git a/changelog.d/cabal-project-local-tilde b/changelog.d/cabal-project-local-tilde
@@ -0,0 +1,3 @@
+synopsis: Tell users about cabal.project.local~ in `cabal v2-configure`
+prs: #6877
+packages: cabal-install
diff --git a/changelog.d/cabal-sdist b/changelog.d/cabal-sdist
@@ -1,11 +1,33 @@
-synopsis: Remove `v1-sdist` command. (TODO: change to sdist imporvements)
-issues: #6635 #4267 #6683
-prs: #6637 #6640 #6660 #6666 #6618 #6681 #6806
+synopsis: Rework `v2-sdist` command
+packages: cabal-install
+issues: #6635 #5813 #2940 #6611 #6514
+prs: #6454 #6637 #6640 #6660 #6666 #6618 #6681 #6884 #6916
+significance: significant
 
 description: {
 
-TBW:
+`v2-sdist` marks all files as readonly in resulting tarballs.
 
-Fix sdist permissions
+The #2940 "cabal sdist should touch preprocessed .hs files" issue
+is fixed by virtue of not doing any preprocessing anymore.
+It's responsibility of packager.
+
+The #6611 "v2-sdist includes a file twice in the tarball " issue
+is fixed as we don't consider only one file list,
+not two separate executable and ordinary file lists.
+
+The #6514 "unpack doesn't preserve (executable) permissions" issue
+is partially resolved,  as there shouldn't be executable permissions
+in the tar files.
+
+The rationale for above simplification is simple. The only file
+Cabal machinery would run is `configure` script. These
+are run with explicit `sh` program. For package internal scripts,
+maintainers should also use interpreters explicitly as well.
+Scripts with shebangs are not executable on Windows.
+
+
+The `v1-sdist` command is removed, as its functionality is completely
+superseded by `v2-sdist`.
 
 }
diff --git a/changelog.d/cabal-spec-3.4 b/changelog.d/cabal-spec-3.4
@@ -1,8 +1,9 @@
 synopsis: Add cabal-version: 3.4
 prs: #6663
+significance: significant
 
 description: {
 
-TBW: link to spec
+See various changes in https://cabal.readthedocs.io/en/latest/file-format-changelog.html#cabal-version-3-4
 
 }
diff --git a/changelog.d/ci b/changelog.d/ci
@@ -14,5 +14,10 @@ prs:
   #6709
   #6827
   #6831
+  #6900
+  #6902
+  #6914
+  #6946
 issues:
   #6500
+  #6945
diff --git a/changelog.d/dependency b/changelog.d/dependency
@@ -1,7 +1,8 @@
 synopsis: Dependency type refactorings
 packages: Cabal
-prs: #6798 #6768
-issues: #5570
+prs: #6798 #6768 #6895 #6896 #6897 #6898
+issues: #5570 #6894
+significance: significant
 
 description: {
 

diff --git a/changelog.d/described b/changelog.d/described
@@ -1,2 +1,8 @@
 synopsis: Grammar / Described
 prs: #6591 #6593 #6704 #6766 #6778 #6780 #6781 #6791 #6800
+
+description: {
+
+TBW
+
+}
diff --git a/changelog.d/documentation b/changelog.d/documentation
@@ -1,2 +1,10 @@
-synopsis: Documentation updates
-prs: #6613 #6560 #6660 #6668 #6669 #6697 #6761
+synopsis: Documentation updates and typo-fixes
+prs:
+  #6613 #6560 #6660 #6668 #6669 #6697 #6761 #6940
+  #6504 #6550 #6686 #6928
+
+description: {
+
+TODO: Higlight larged changes
+
+}
diff --git a/changelog.d/expose-all-unfoldings b/changelog.d/expose-all-unfoldings
@@ -1,8 +1,9 @@
-synopsis: Add -fexpose-all-unfoldings to parsec and Cabal in release project 
+synopsis: Add -fexpose-all-unfoldings to parsec and Cabal in release project
+packages: cabal-install
 prs: #6708
 
 description: {
 
-This makes parser faster.
+This makes parser faster with acceptable code-size increase.
 
 }
diff --git a/changelog.d/ghc-8.12 b/changelog.d/ghc-8.12
@@ -1,11 +1,19 @@
 synopsis: Support GHC-8.12
-prs: #6735 #6844 #6865
+prs:
+  #6735 #6844 #6865 #6848 #6908 #6947
+  #6552 #6553 #6563 #6545
+issues: #6903 #6904 #6905
+significance: significant
 
 description: {
 
 - Support for -this-package-key deprecation
 - Use process createPipe
-- TODO: add simplified subsumption here
+- Add support for WINIO to Cabal
+- Adopt to simplfied subsumption changes
 
+There are no magical 'IO =`WithCallStack Prelude.IO` alias in Cabal,
+as it is hard to get working with GHC-8.12's simplified subsumption.
+Accept "linux-androideabi" as an alias for Android
 
 }
diff --git a/changelog.d/ghci-fix b/changelog.d/ghci-fix
@@ -0,0 +1,8 @@
+synopsis: Fix ghci being launched before other sources are built.
+prs: #6923
+
+description: {
+
+TBW. Related to foreign calls to C-sources.
+
+}
diff --git a/changelog.d/help-remove-new-aliases b/changelog.d/help-remove-new-aliases
@@ -0,0 +1,3 @@
+synopsis: Remove new- command from `--help` output (there are v2-)
+prs: #6930
+packages: cabal-install
diff --git a/changelog.d/index-state b/changelog.d/index-state
@@ -2,3 +2,4 @@ synopsis: More rich `index-state` syntax. `v2-freeze` saves `index-state`.
 packages: cabal-install
 prs: #6596 #6581 #6597 #6591 #6682 #6733
 issues: #6728
+significance: significant
diff --git a/changelog.d/install-prints-destination b/changelog.d/install-prints-destination
@@ -1,2 +1,3 @@
 synopsis: Installing (copy or symlink) executable message prints destination.
 prs: #6590 #6582
+packages: cabal-install
diff --git a/changelog.d/issue-4267 b/changelog.d/issue-4267
diff --git a/changelog.d/issue-4746 b/changelog.d/issue-4746
@@ -1,3 +1,4 @@
 synopsis: all extra-source-files are change-tracked
 packages: cabal-install
 issues: #4746
+prs: #6889
diff --git a/changelog.d/issue-5224 b/changelog.d/issue-5224
@@ -1,3 +1,4 @@
 synopsis: `upload --help` now includes `password-command` as a config file option (#5224)
+packages: cabal-install
 issues: #5224
 prs: #6609 #6313 #6680
diff --git a/changelog.d/issue-5586 b/changelog.d/issue-5586
@@ -1,3 +1,12 @@
-synopsis: source-repository-package directories aren't local
+synopsis: `source-repository-package` directories aren't local
+packages: cabal-install
 issues: #5586
-prs: #6917
+prs: #6917 #6915
+significance: significant
+
+description: {
+
+Concretely these means that compiled `source-repository-package` entries
+used in different projects are stored in the global nix-style store.
+
+}
diff --git a/changelog.d/issue-5813 b/changelog.d/issue-5813
diff --git a/changelog.d/issue-5973 b/changelog.d/issue-5973
@@ -1,4 +1,5 @@
 synopsis: Use default install directory if not specified
+packages: cabal-install
 prs: #6624
 issues: #5973
 

diff --git a/changelog.d/issue-6083 b/changelog.d/issue-6083
@@ -1,3 +1,23 @@
-synopsis: Treat pkg:sublib dependency syntax as is since 3.4
+synopsis: Treat pkg:sublib dependency syntax as is in `cabal-version: 3.4`
 issues: #6083
-prs: #6907
+prs: #6907 #6893
+significance: significant
+
+description: {
+
+In `cabal-version: 3.4` cabal files the dependency definition
+
+```cabal
+build-depends: somesublib
+```
+
+is not using in-package sublibraries. You have to be explicit and write
+
+```cabal
+build-depends: thispkg:somesublib
+```
+
+This fixes an issue, where it was impossible to refer to extenral
+library, if you had sublibrary of the same name.
+
+}
diff --git a/changelog.d/issue-6150 b/changelog.d/issue-6150
diff --git a/changelog.d/issue-6210 b/changelog.d/issue-6210
@@ -1,3 +1,4 @@
 synopsis: Default to 'NoReports' for remote build reporting
+packages: cabal-install
 issues: #6210
 prs: #6625
diff --git a/changelog.d/issue-6565 b/changelog.d/issue-6565
@@ -1,4 +1,4 @@
-synopsis: Update GHC environment location (fixes #6565)
+synopsis: Update GHC environment location
 prs: #6822
 issues: #6565
 packages: cabal-install

diff --git a/changelog.d/issue-6610 b/changelog.d/issue-6610
@@ -4,6 +4,8 @@ prs: #6684
 
 description: {
 
-Add pijul to known repository type
+Pijul is now explicitly recognized version control system.
+However `cabal-install` isn't yet able to use it in
+`source-repository-package`.
 
 }
diff --git a/changelog.d/issue-6622 b/changelog.d/issue-6622
@@ -1,3 +1,4 @@
 synopsis: Prepend hs-source-dir to match-component, fixes `cabal repl file`
-prs: #6623 #6826
+packages: cabal-install
+prs: #6623 #6826 #6875
 issues: #6622
diff --git a/changelog.d/issue-6675 b/changelog.d/issue-6675
diff --git a/changelog.d/issue-6691 b/changelog.d/issue-6691
@@ -1,4 +1,5 @@
 synopsis: Remove upgrade, uninstall and win32selfupgrade commands
+packages: cabal-install
 issues: #6691
 prs: #6707
 

diff --git a/changelog.d/issue-6710 b/changelog.d/issue-6710
@@ -1,2 +1,16 @@
 synopsis: Rename Flag to CompilerFlag and PackageFlag
+packages: Cabal
 issues: #6710
+prs: #6725
+
+description: {
+
+There was three Flag's. Now they are
+
+- `Flag` (cli parsing)
+- `PackageFlag`
+- `CompilerFlag`
+
+This allows wild-imports without `hiding (Flag)`.
+
+}
diff --git a/changelog.d/issue-6729 b/changelog.d/issue-6729
@@ -2,3 +2,10 @@ synopsis: Remove local-repo
 packages: cabal-install
 issues: #6729
 prs: #6730
+
+description: {
+
+This functionality was mainly used by removed sandboxes.
+`file+noindex` repositories are better variant for local package repositories.
+
+}
diff --git a/changelog.d/issue-6807 b/changelog.d/issue-6807
@@ -1,3 +1,11 @@
 synopsis: Add list-bin command
 packages: cabal-install
 issues: #6807
+prs: #6931
+significance: significant
+
+description: {
+
+`cabal list-bin executable-component` tells the path to the build artifact.
+
+}
diff --git a/changelog.d/linux-androideabi b/changelog.d/linux-androideabi
@@ -0,0 +1,9 @@
+synopsis: Accept "linux-androideabi" as an alias for Android for determining buildOS
+prs: #6949 #6301
+packages: Cabal
+
+description: {
+
+`Cabal` will able to parse `linux-androideabi` from the value of `System.Info.os`.
+
+}
diff --git a/changelog.d/man-command b/changelog.d/man-command
@@ -1,2 +1,3 @@
 synopsis: Change manpage command to man
+packages: cabal-install
 prs: #6548
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,5 +14,10 @@ prs: @@
       #6709
       #6827
       #6831
+      #6900
+      #6902
+      #6914
+      #6946
     issues:
       #6500
+      #6945