Ticket #873: patch873.dpatch

2 patches for repository http://darcs.haskell.org/cabal:

Sat Aug 13 23:09:34 CEST 2011  Joachim Breitner <mail@joachim-breitner.de>
  * Remove duplicated comment header
  The same header appears further above.

Sat Aug 13 23:26:04 CEST 2011  Joachim Breitner <mail@joachim-breitner.de>
  * Add checkChangelogExists check
  
  This makes cabal check warn about a missing changelog if no commonly named
  changelog file is found. Fixes #873.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


New patches:

[Remove duplicated comment header
Joachim Breitner <mail@joachim-breitner.de>**20110813210934
 Ignore-this: d420950822b9f3b7a38bd001d426feab
 The same header appears further above.
] hunk ./cabal/Distribution/PackageDescription/Check.hs 1339
 repoTypeDirname Monotone   = ["_MTN"]
 repoTypeDirname _          = []
 
- --- ------------------------------------------------------------
- --- * Checks involving files in the package
- --- ------------------------------------------------------------
- -
 -- | Check the names of all files in a package for portability problems. This
 -- should be done for example when creating or validating a package tarball.
 --
[Add checkChangelogExists check
Joachim Breitner <mail@joachim-breitner.de>**20110813212604
 Ignore-this: 53610c2452018584720889f09d825e7
 
 This makes cabal check warn about a missing changelog if no commonly named
 changelog file is found. Fixes #873.
] {
hunk ./cabal/Distribution/PackageDescription/Check.hs 1252
   configureError  <- checkConfigureExists ops pkg
   localPathErrors <- checkLocalPathsExist ops pkg
   vcsLocation     <- checkMissingVcsInfo  ops pkg
+  changeLogExists <- checkChangelogExists ops pkg
 
   return $ catMaybes [licenseError, setupError, configureError]
         ++ localPathErrors
hunk ./cabal/Distribution/PackageDescription/Check.hs 1257
         ++ vcsLocation
+        ++ changeLogExists
 
 checkLicenseExists :: Monad m => CheckPackageContentOps m
                    -> PackageDescription
hunk ./cabal/Distribution/PackageDescription/Check.hs 1341
 repoTypeDirname Monotone   = ["_MTN"]
 repoTypeDirname _          = []
 
+checkChangelogExists :: Monad m => CheckPackageContentOps m
+                        -> PackageDescription
+                        -> m [PackageCheck]
+checkChangelogExists ops pkg = do
+    hasChangelog <- liftM or $ mapM (doesFileExist ops) changelogFilenames
+    if hasChangelog 
+      then return []
+      else return [ PackageDistSuspicious message ]
+  where
+    changelogFilenames = [ "CHANGES", "ChangeLog", "changelog", "NEWS" ]
+    message  = "Distributed packages should inform the user about the changes "
+            ++ "in the various files. Please include a changelog file. The "
+            ++ "suggest file name is \"CHANGES\"."
+
 -- | Check the names of all files in a package for portability problems. This
 -- should be done for example when creating or validating a package tarball.
 --
}

Context:

[Relax cabal-install's deps for ghc-7.2
Duncan Coutts <duncan@community.haskell.org>**20110812110846
 Ignore-this: 1524732bffa5cc04e5d475ec4c4f12d8
] 
[Fix the repo location
Duncan Coutts <duncan@community.haskell.org>**20110812110820
 Ignore-this: 1ed9152864fc3336c82495904b1e5612
] 
[Improve the error message emitted when multiple .cabal files are found
Duncan Coutts <duncan@community.haskell.org>**20110508223014
 Ignore-this: 1c96d4f42fe55094f07b0573bb80fda1
] 
[Add Safe Haskell flags to known extensions
David Terei <davidterei@gmail.com>**20110810201543
 Ignore-this: 9e0a42de1539e1a56d72f9a7ecdf554c
] 
[Change trusted property to be true by default
David Terei <davidterei@gmail.com>**20110808223228
 Ignore-this: c46cf169c46b809cf457678f77e02b20
] 
[Fix for intra-package build-tools dependencies
Duncan Coutts <duncan@community.haskell.org>**20110808165045
 Ignore-this: 83f148981c7d8d3c616027975ee8f59a
] 
[Simplify some code in Program.Hpc slightly
Duncan Coutts <duncan@community.haskell.org>**20110726001531
 Ignore-this: d7ea77d1f072f7071fc709e0c9a38ded
] 
[Added Distribution.Simple.Program.Hpc.
Thomas Tuegel <ttuegel@gmail.com>**20110719004251
 Ignore-this: a988f4262e4f52c8ae0a3ca5715a636e
] 
[Restore graceful failure upon invoking "cabal test" before "cabal build".
Thomas Tuegel <ttuegel@gmail.com>**20110719002218
 Ignore-this: 2096a4cfad17eb67ef26bb15a8b3a066
] 
[Fix executable test suite unit test for improved HPC interface.
Thomas Tuegel <ttuegel@gmail.com>**20110718033150
 Ignore-this: b543b01721940b23aac7bd46282425b1
] 
[Generate aggregate coverage statistics from all test suites in package.
Thomas Tuegel <ttuegel@gmail.com>**20110718050448
 Ignore-this: bff5f3167ab61da015b8fcb7c4f77cdc
] 
[Invoke HPC using D.S.Program utilities.
Thomas Tuegel <ttuegel@gmail.com>**20110718045949
 Ignore-this: 37e1f01f594dd522c5328b397ac0e94d
 This patch also reorganizes the HPC output directories for consistency. All
 files related to HPC are now located in the "dist/hpc" directory.
] 
[Fix cabal haddock for packages with internal dependencies
Duncan Coutts <duncan@community.haskell.org>**20110718235728
 Ignore-this: 86cdab6325a86875e9ae592881b4f54f
] 
[Update cabal sdist to follow the changes in the Cabal lib
Duncan Coutts <duncan@community.haskell.org>**20110717223648
 Ignore-this: 1136aa98cb024a10250ea75ec8633a2c
] 
[Added unit test for test options.
Thomas Tuegel <ttuegel@gmail.com>**20110521164529
 Ignore-this: 3dc94c06cdfacf20cf000682370fbf3
] 
[Fixed crash on Windows due to file handle leak.
Thomas Tuegel <ttuegel@gmail.com>**20110518030422
 Ignore-this: c94eb903aef9ffcf52394a821d245dda
 Ticket #843. Cabal test crashed when trying to delete a temporary log file
 because 'readFile' reads unnecessarily lazily and was keeping a file handle
 open during attempted deletion. This patch forces the entire file to be read
 so the handle will be closed.
] 
[Stop cabal-install from duplicating test options.
Thomas Tuegel <ttuegel@gmail.com>**20110521232047
 Ignore-this: 55b98ab47306178e355cacedc7a5a6d2
] 
[Fix use of multiple test options.
Thomas Tuegel <ttuegel@gmail.com>**20110521223029
 Ignore-this: c694ad21faab23abb7157ccec700ccf2
] 
[Don't prefix test output with ">>>".
Thomas Tuegel <ttuegel@gmail.com>**20110708035007
 Ignore-this: a9d417eb836c641339a0203d1c36e82e
 Ticket #848. Removing the prefix brings "cabal test" in line with other cabal
 commands, which do not prefix their output, either. Prior to this patch, the
 summary notices which appear before and after each test suite were written to
 the temporary log file along with the stdio from the test executable; this would
 lead to duplicate notices when the contents of the temporary log file are read
 onto the console. After this patch, the summary notices are never written to the
 temporary log file, only to the console and the final log file (which is never
 read by Cabal), removing the confusing duplicate notices.
] 
[Fail gracefully when running "setup test" before "setup build".
Thomas Tuegel <ttuegel@gmail.com>**20110303164611
 Ignore-this: a4d818cd7702ddbbbbffc8679abeb85d
] 
[Bump cabal-install version
Duncan Coutts <duncan@community.haskell.org>**20110708013248
 Ignore-this: 16626faad564787fc5ae3808d1e6ccc9
] 
[Bump Cabal lib version
Duncan Coutts <duncan@community.haskell.org>**20110708013245
 Ignore-this: e01c7efbb68856167c227ba118ddce33
] 
[Couple of trivial code changes
Duncan Coutts <duncan@community.haskell.org>**20110708013012
 Ignore-this: b98aaac9e33f8c684cefedcd05d37ee2
] 
[Fix withComponentsLBI and move Components to LocalBuildInfo module
Duncan Coutts <duncan@community.haskell.org>**20110708012122
 Ignore-this: 57217119f7825c9bcd3824a34ecd0c8f
 An annoyance of the current Simple build system is that each phase
 (build, install, etc) can be passed additional HookedBuildInfo which
 gets merged into the PackageDescription. This means that we cannot
 process the PackageDescription up front at configure time and just
 store and reuse it later, we have to work from it each time afresh.
 
 The recent addition of Components (libs, exes, test suites) and a
 topoligical sort of the components in the LocalBuildInfo fell foul
 of this annoyance. The LocalBuildInfo stored the entire component
 which meant they were not updated with the HookedBuildInfo. This
 broke packages with custom Setup.hs scripts that took advantage of
 the HookedBuildInfo feature, including those with configure scripts.
 
 The solution is to store not the list of whole components but the
 list of component names. Then withComponentsLBI retrieves the actual
 components from the PackageDescription which thus includes the
 HookedBuildInfo.
 
 Also moved the Components into an internal module because (for the
 moment at least) it is part of the Simple build system, not part of
 the package description.
] 
[Relax some dependencies
Ian Lynagh <igloo@earth.li>**20110706192619
 Ignore-this: 6353c1d64a2fff3cef3ca0d8a9f2e95e
] 
[Add files needed by the GHC build system
Ian Lynagh <igloo@earth.li>**20110624003654
 Ignore-this: a40dd98104e994d1a1648c3ce2676a45
] 
[Add a dash separator for pid in createTempDirectory and openBinaryTempFile too
Jens Petersen <juhp@community.haskell.org>**20110519021658
 Ignore-this: ee0c842388212326579309ac6f93408f
] 
[Update changelog for 1.10.2.0
Duncan Coutts <duncan@community.haskell.org>**20110618190748
 Ignore-this: 64129f45dd16d2d93c82097530dc15d1
] 
[TAG cabal-install merged
Duncan Coutts <duncan@community.haskell.org>**20110619135228
 Ignore-this: 58d670de46a24046d0b869dc2b88e13a
 We now have both the Cabal library and the cabal-install tool
 together in the same repo, each in a subdir.
     
 The idea is that this will make splitting packages and moving
 code between package rather easier in future.
] 
Patch bundle hash:
b95b825517a7ee4245b11669148b095e20b8f11b
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)

iEYEARECAAYFAk5G7K8ACgkQ9ijrk0dDIGwwBgCfaUU5LRkqS5ekOvQ5qL75U9EH
Eu8AoIH/JXeIYj3/rXX8G04qpeA7ntkx
=Lx7q
-----END PGP SIGNATURE-----