Merge pull request #6950 from phadej/changelog-3.4

Update changelog for 3.4

Cabal/Distribution/Compat/DList.hs

@@ -32,6 +32,7 @@ runDList (DList run) = run []
 singleton :: a -> DList a
 singleton a = DList (a:)
 
+-- | @since 3.4.0.0
 empty :: DList a
 empty = DList id
 

Cabal/Distribution/Compat/NonEmptySet.hs

@@ -39,6 +39,7 @@ import Control.Applicative (empty)
 import Control.Monad (fail)
 #endif
 
+-- | @since 3.4.0.0
 newtype NonEmptySet a = NES (Set.Set a)
   deriving (Eq, Ord, Typeable, Data, Read)
 

Cabal/Distribution/Simple/GHC.hs

@@ -364,6 +364,8 @@ toPackageIndex verbosity pkgss progdb = do
     ghcProg = fromMaybe (error "GHC.toPackageIndex: no ghc program") $ lookupProgram ghcProgram progdb
 
 -- | Return the 'FilePath' to the GHC application data directory.
+--
+-- @since 3.4.0.0
 getGhcAppDir :: IO FilePath
 getGhcAppDir = getAppUserDataDirectory "ghc"
 

Cabal/Distribution/Types/Dependency.hs

@@ -166,6 +166,8 @@ versionGuardMultilibs = do
     ]
 
 -- | Library set with main library.
+--
+-- @since 3.4.0.0
 mainLibSet :: NonEmptySet LibraryName
 mainLibSet = NES.singleton LMainLibName
 

Cabal/Distribution/Types/Mixin.hs

@@ -79,6 +79,8 @@ versionGuardMultilibs = do
     ]
 
 -- | Smart constructor of 'Mixin', enforces invariant.
+-- 
+-- @since 3.4.0.0
 mkMixin :: PackageName -> LibraryName -> IncludeRenaming -> Mixin
 mkMixin pn (LSubLibName uqn) incl
     | packageNameToUnqualComponentName pn == uqn

Cabal/Distribution/Types/PackageVersionConstraint.hs

@@ -63,11 +63,12 @@ instance Parsec PackageVersionConstraint where
       else
           pure (PackageVersionConstraint name (thisVersion ver))
 
-
+-- | @since 3.4.0.0
 thisPackageVersionConstraint :: PackageIdentifier -> PackageVersionConstraint
 thisPackageVersionConstraint (PackageIdentifier pn vr) =
     PackageVersionConstraint pn (thisVersion vr)
 
+-- | @since 3.4.0.0
 simplifyPackageVersionConstraint :: PackageVersionConstraint -> PackageVersionConstraint
 simplifyPackageVersionConstraint (PackageVersionConstraint pn vr) =
     PackageVersionConstraint pn (simplifyVersionRange vr)

Cabal/Distribution/Types/SourceRepo.hs

@@ -125,7 +125,8 @@ instance NFData RepoKind where rnf = genericRnf
 -- obtain and track the repo depend on the repo type.
 --
 data KnownRepoType = Darcs | Git | SVN | CVS
-                   | Mercurial | GnuArch | Bazaar | Monotone | Pijul
+                   | Mercurial | GnuArch | Bazaar | Monotone
+                   | Pijul -- ^ @since 3.4.0.0
   deriving (Eq, Generic, Ord, Read, Show, Typeable, Data, Enum, Bounded)
 
 instance Binary KnownRepoType

Cabal/Distribution/Verbosity.hs

@@ -279,10 +279,14 @@ verboseNoTimestamp :: Verbosity -> Verbosity
 verboseNoTimestamp = verboseNoFlag VTimestamp
 
 -- | Turn on timestamps for log messages.
+--
+-- @since 3.4.0.0
 verboseStderr :: Verbosity -> Verbosity
 verboseStderr = verboseFlag VStderr
 
 -- | Turn off timestamps for log messages.
+--
+-- @since 3.4.0.0
 verboseNoStderr :: Verbosity -> Verbosity
 verboseNoStderr = verboseNoFlag VStderr
 
@@ -326,6 +330,8 @@ isVerboseTimestamp :: Verbosity -> Bool
 isVerboseTimestamp = isVerboseFlag VTimestamp
 
 -- | Test if we should output to stderr when we log.
+--
+-- @since 3.4.0.0
 isVerboseStderr :: Verbosity -> Bool
 isVerboseStderr = isVerboseFlag VStderr
 

Cabal/Distribution/Verbosity/Internal.hs

@@ -20,7 +20,7 @@ data VerbosityFlag
     | VNoWrap
     | VMarkOutput
     | VTimestamp
-    | VStderr
+    | VStderr -- ^ @since 3.4.0.0
     deriving (Generic, Show, Read, Eq, Ord, Enum, Bounded, Typeable)
 
 instance Binary VerbosityFlag

changelog.d/Cabal-QuickCheck

+synopsis: Cabal-QuickCheck package with `Arbirary` instances
+prs: #6557 #6891
+issues: #6882
+packages: Cabal

changelog.d/Cabal-tree-diff

+synopsis: Create Cabal-tree-diff package with `ToExpr` instances
+prs: #6789
+packages: Cabal

changelog.d/PerCompilerFlavor-functor

+synopsis: `Cabal.Distribution.Compiler`: add `Traversable` instance for `PerCompilerFlavor`
+prs: #6763
+packages: Cabal

changelog.d/active-repositories

 synopsis: Add active-repositories configuration
 packages: cabal-install
-prs: #6724
+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`.
+
+}

changelog.d/added-tests

+synopsis: Tests additions
+prs: #6753 #6759 #6802 #6842 #6872
+issues: #6409
+
+description: {
+
+- Add shrinker, so writing big non-generic product shrinkers is easier
+- Add `hs-source-dirs: NL .` test-case
+- Add public multilib test(s)
+
+}

changelog.d/backported

+synopsis: Backported to 3.2
+packages: Cabal-internal
+prs:
+  -- solver
+  #5918 #6447
+  -- buildinfo generator
+  #6258
+  -- bump version
+  #6426
+  -- cabal install -z
+  #6428
+  -- incomplete-uni-patterns
+  #6433
+  -- packages/optional packages empty
+  #6436
+  -- file+noindex
+  #6448
+  -- documentation
+  #6450 #6464 #6473 #6546
+  -- bounds
+  #6455
+  -- safe functions
+  #6456
+  -- Improve few internalErrors in InstallPlan
+  #6439
+  -- v2-run -z
+  #6457
+  -- test fixes
+  #6463 #6499 #6518
+  -- CI
+  #6469
+  -- show full abi hash
+  #6498 #6496 #6476
+  -- Create distTempDirectory in withTempEnvFile
+  #6501
+  -- cabal_macros.h zinza
+  -- TODO: check whether it made to 3.2
+  -- issue: #6533
+  #6502 #6535
+  -- disallow spaces around : in dependency
+  #6538
+  -- pkg-config
+  #6540 #6541

changelog.d/build-reports

+synopsis: Change `BuildReports` parse/pretty to use FieldGrammar framework
+prs: #6783
+packages: cabal-install

changelog.d/cabal-init

 synopsis: Various `cabal init` improvements
 packages: cabal-install
-prs: #6619 #6661 #6641 #6650 #6603 #6632 #6607
+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
 }

changelog.d/cabal-list

+synopsis: `cabal list` accepts regular expression
+packages: cabal-install
+prs: #6618 #6806
+issues: #4267 #6683
+significance: significant

changelog.d/cabal-project-local-tilde

+synopsis: Tell users about `cabal.project.local~` in `cabal v2-configure`
+prs: #6877
+packages: cabal-install

changelog.d/issue-5813 → changelog.d/cabal-sdist

-synopsis: Fix v2-sdist permissions, they are now always readonly
-prs: #6454
-issues: #5813 #2940 #6611 #6514
+synopsis: Rework `v2-sdist` command
+packages: cabal-install
+issues: #6635 #5813 #2940 #6611 #6514
+prs: #6454 #6637 #6640 #6660 #6666 #6884 #6916
+significance: significant
 
 description: {
-The #2940 "cabal sdist should touch preprocessed .hs files" issu
+
+`v2-sdist` marks all files as readonly in resulting tarballs.
+
+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.
 
@@ -21,4 +26,7 @@ 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`.
+
 }