WIP

phadej · phadej · commit b28ec92c9baf · 2020-07-13T14:52:16.000+03:00
diff --git a/.prlog b/.prlog
diff --git a/changelog.d/Cabal-QuickCheck b/changelog.d/Cabal-QuickCheck
@@ -1,4 +1,4 @@
-synopsis: Cabal-QuickCheck package with Arbirary instances
+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,3 +1,3 @@
-synopsis: Create Cabal-tree-diff package with ToExpr instances
+synopsis: Create Cabal-tree-diff package with `ToExpr` instances
 prs: #6789
 packages: Cabal
diff --git a/changelog.d/PerCompilerFlavor-functor b/changelog.d/PerCompilerFlavor-functor
@@ -1,3 +1,3 @@
-synopsis: Cabal.Distribution.Compiler: add Traversable instance for PerCompilerFlavor
+synopsis: `Cabal.Distribution.Compiler`: add `Traversable` instance for `PerCompilerFlavor`
 prs: #6763
 packages: Cabal
diff --git a/changelog.d/added-tests b/changelog.d/added-tests
@@ -5,7 +5,7 @@ issues: #6409
 description: {
 
 - Add shrinker, so writing big non-generic product shrinkers is easier
-- Add hs-source-dirs: NL . test-case
+- Add `hs-source-dirs: NL .` test-case
 - Add public multilib test(s)
 
 }
diff --git a/changelog.d/build-reports b/changelog.d/build-reports
@@ -1,3 +1,3 @@
-synopsis: Change BuildReports parse/pretty to use FieldGrammar framework
+synopsis: Change `BuildReports` parse/pretty to use FieldGrammar framework
 prs: #6783
 packages: cabal-install
diff --git a/changelog.d/cabal-project-local-tilde b/changelog.d/cabal-project-local-tilde
@@ -1,3 +1,3 @@
-synopsis: Tell users about cabal.project.local~ in `cabal v2-configure`
+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,7 +1,7 @@
 synopsis: Rework `v2-sdist` command
 packages: cabal-install
 issues: #6635 #5813 #2940 #6611 #6514
-prs: #6454 #6637 #6640 #6660 #6666 #6618 #6681 #6884 #6916
+prs: #6454 #6637 #6640 #6660 #6666 #6884 #6916
 significance: significant
 
 description: {
@@ -26,7 +26,6 @@ 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/changelog b/changelog.d/changelog
@@ -1,2 +1,3 @@
 synopsis: Changelog entries
+packages: Cabal-internal
 prs: #6634 #6950
diff --git a/changelog.d/ci b/changelog.d/ci
@@ -1,4 +1,5 @@
 synopsis: CI tweaks
+packages: Cabal-internal
 prs:
   #6494
   #6518
diff --git a/changelog.d/code-organization b/changelog.d/code-organization
@@ -3,14 +3,14 @@ prs: #6599 #6642 #6734 #6745 #6746 #6817 #6818 #6821 #6867
 
 description: {
 
-- Split D.Client.Types module
+- Split `Distribution.Client.Types` module
 - Move cabal-testsuite code into `src/`
-- Add ProjectFlags
-- Make NixStyleOptions
+- Add `ProjectFlags`
+- Add `NixStyleOptions`
 - Internal refactorings to install command.
-- Make own modules for InstallMethod and OverwritePolicy
-- Make cabal-install compilable with NoImplicitPrelude
-- Refactor shared TargetProblem data types into their own module.
-- Template cabal-install.cabal using zinza
+- Make own modules for `InstallMethod` and `OverwritePolicy`
+- Make cabal-install compilable with `NoImplicitPrelude`
+- Refactor shared `TargetProblem` data types into their own module.
+- Template `cabal-install.cabal` using zinza
 
 }
diff --git a/changelog.d/described b/changelog.d/described
@@ -1,8 +1,8 @@
-synopsis: Grammar / Described
+synopsis: The grammar of most package description fields is formally documented
 prs: #6591 #6593 #6704 #6766 #6778 #6780 #6781 #6791 #6800
 
 description: {
 
-TBW
+See https://cabal.readthedocs.io/en/latest/buildinfo-fields-reference.html
 
 }
diff --git a/changelog.d/ghc-8.12 b/changelog.d/ghc-8.12
@@ -7,13 +7,12 @@ significance: significant
 
 description: {
 
-- Support for -this-package-key deprecation
-- Use process createPipe
+- Support for `-this-package-key` deprecation
+- Use process `createPipe`
 - Add support for WINIO to Cabal
 - Adopt to simplfied subsumption changes
 
-There are no magical 'IO =`WithCallStack Prelude.IO` alias in Cabal,
+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
@@ -3,6 +3,6 @@ prs: #6923
 
 description: {
 
-TBW. Related to foreign calls to C-sources.
+Related to foreign calls to C-sources.
 
 }
diff --git a/changelog.d/issue-6691 b/changelog.d/issue-6691
@@ -5,6 +5,9 @@ prs: #6707
 
 description: {
 
-Remove unimplemented commands. TBW note about win32selfupgrade
+This commands were not implemented or are special purpose.
+The removal of `win32selfupgrade` might break self upgrade on windows,
+when `cabal-install` tries to rewrite the binary of itself.
+This shouldn't be a problem when symlinking is used.
 
 }
diff --git a/changelog.d/parser-benchmark b/changelog.d/parser-benchmark
@@ -1,8 +1,2 @@
-synopsis: Parser benchmark
+synopsis: Package description parser benchmark
 prs: #6594
-
-description: {
-
-TBW... (easier to assert parser changes)
-
-}
diff --git a/changelog.d/pr-6878 b/changelog.d/pr-6878
@@ -1,3 +1,3 @@
-synopsis: Add licenceIsFsfLibre
+synopsis: Add `licenceIsFsfLibre`
 packages: Cabal
 prs: #6878
diff --git a/changelog.d/pr-6929 b/changelog.d/pr-6929
@@ -1,2 +1,2 @@
-synopsis: Add +stderr modifier to verbosity
+synopsis: Add `+stderr` modifier to `Verbosity`
 prs: #6929
diff --git a/changelog.d/remove-sandbox b/changelog.d/remove-sandbox
@@ -6,6 +6,6 @@ significance: significant
 
 description: {
 
-I should probably say something
+Sandbox functionality is remove in favour of now default nix-style builds.
 
 }
diff --git a/changelog.d/symlinking-windows b/changelog.d/symlinking-windows
@@ -3,5 +3,9 @@ packages: cabal-install
 prs: #5684 #6506 #6519
 
 description: {
-TBW
+
+`cabal-install` will try to infer whether symlinking is supported on Windows,
+and make symlinks in `install`. Otherwise it will fallback to copying files.
+Either way can be forced with `--install-method`.
+
 }
diff --git a/changelog.d/utf8 b/changelog.d/utf8
@@ -1,3 +1,3 @@
-synopsis: Better UTF8 handling, parsed ShortText should be valid now
+synopsis: Better UTF8 handling, parsed `ShortText` is now valid.
 packages: Cabal
 prs: #6588
diff --git a/changelog.d/version-type b/changelog.d/version-type
@@ -1,10 +1,10 @@
-synopsis: Remove AnyVersion and WildcardVersion constructors from Version
+synopsis: Remove `AnyVersion` and `WildcardVersion` constructors from `Version`
 packages: Cabal
 prs: #6742
 
 description: {
 
-Make Version type less "syntactic", i.e. contains less constructors
-for semantically same version ranges.
+This changes makes `Version` type less "syntactic",
+i.e. contains less constructors for semantically same version ranges.
 
 }
diff --git a/changelog.d/weeder b/changelog.d/weeder
@@ -1,2 +1,2 @@
-synopsis: Add / use weeder
+synopsis: Add and use weeder
 prs: #6779 #6790
diff --git a/notes/Cabal-3.4.0.0.md b/notes/Cabal-3.4.0.0.md
diff --git a/notes/cabal-install-3.4.0.0.md b/notes/cabal-install-3.4.0.0.md

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ issues: #6409`
`5`	`5`	`description: {`
`6`	`6`
`7`	`7`	`- Add shrinker, so writing big non-generic product shrinkers is easier`
`8`		`-- Add hs-source-dirs: NL . test-case`
	`8`	+- Add `hs-source-dirs: NL .` test-case
`9`	`9`	`- Add public multilib test(s)`
`10`	`10`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`synopsis: Changelog entries`
	`2`	`+packages: Cabal-internal`
`2`	`3`	`prs: #6634 #6950`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`synopsis: CI tweaks`
	`2`	`+packages: Cabal-internal`
`2`	`3`	`prs:`
`3`	`4`	`#6494`
`4`	`5`	`#6518`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,8 @@`
`1`		`-synopsis: Grammar / Described`
	`1`	`+synopsis: The grammar of most package description fields is formally documented`
`2`	`2`	`prs: #6591 #6593 #6704 #6766 #6778 #6780 #6781 #6791 #6800`
`3`	`3`
`4`	`4`	`description: {`
`5`	`5`
`6`		`-TBW`
	`6`	`+See https://cabal.readthedocs.io/en/latest/buildinfo-fields-reference.html`
`7`	`7`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@ prs: #6923`
`3`	`3`
`4`	`4`	`description: {`
`5`	`5`
`6`		`-TBW. Related to foreign calls to C-sources.`
	`6`	`+Related to foreign calls to C-sources.`
`7`	`7`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@ prs: #6707`
`5`	`5`
`6`	`6`	`description: {`
`7`	`7`
`8`		`-Remove unimplemented commands. TBW note about win32selfupgrade`
	`8`	`+This commands were not implemented or are special purpose.`
	`9`	+The removal of `win32selfupgrade` might break self upgrade on windows,
	`10`	+when `cabal-install` tries to rewrite the binary of itself.
	`11`	`+This shouldn't be a problem when symlinking is used.`
`9`	`12`
`10`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-synopsis: Add +stderr modifier to verbosity`
	`1`	+synopsis: Add `+stderr` modifier to `Verbosity`
`2`	`2`	`prs: #6929`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@ significance: significant`
`6`	`6`
`7`	`7`	`description: {`
`8`	`8`
`9`		`-I should probably say something`
	`9`	`+Sandbox functionality is remove in favour of now default nix-style builds.`
`10`	`10`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-synopsis: Add / use weeder`
	`1`	`+synopsis: Add and use weeder`
`2`	`2`	`prs: #6779 #6790`