Ticket #277: cabal-add-data-dir-field.patch

New patches:

[add data-dir field to package config
Bertram Felgenhauer <int-e@gmx.de>**20080509130448
 Cabal will look for data files to install relative to the directory given
 in the data-dir field, allowing package authors to better structure their
 source tree. There's no behavioural change by default.
] {
hunk ./Distribution/PackageDescription/Parse.hs 146
+ , simpleField "data-dir"
+           showFilePath           parseFilePathQ
+           dataDir                (\val pkg -> pkg{dataDir=val})
hunk ./Distribution/PackageDescription.hs 132
+        dataDir        :: FilePath,
hunk ./Distribution/PackageDescription.hs 163
+                      dataDir      = "",
hunk ./Distribution/Simple/Install.hs 106
-      copyFileVerbose verbosity file (dataPref </> file)
+      copyFileVerbose verbosity (dataDir pkg_descr </> file) (dataPref </> file)
hunk ./Distribution/Simple/SrcDist.hs 151
-  flip mapM_ (dataFiles pkg_descr) $ \ file -> do
-    let dir = takeDirectory file
+  flip mapM_ (dataFiles pkg_descr) $ \ filename -> do
+    let file = dataDir pkg_descr </> filename
+        dir = takeDirectory file
}

[document data-dir field
Bertram Felgenhauer <int-e@gmx.de>**20080509131306] {
hunk ./doc/Cabal.xml 671
+            <term>
+              <literal>data-dir:</literal>
+              <replaceable>directory</replaceable>
+            </term>
+            <listitem>
+              <para>The directory where Cabal looks for data files to install,
+                relative to the source directory. By default, Cabal will look
+                in the source directory itself.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
}

Context:

[Add PackageIndex.reverseDependencyClosure
Duncan Coutts <duncan@haskell.org>**20080506234902
 It's similar to dependencyClosure but looks at reverse dependencies.
 For example it's useful to find all packages that depend on broken
 packages and are thus themselves broken.
] 
[Improve style and performance of PackageIndex.dependencyClosure
Duncan Coutts <duncan@haskell.org>**20080506234447
 Keep the completed set as another PackageIndex rather than a list.
 We want to return an index at the end anyway and in the mean time
 we want to do lots of lookups to see if we've visited previously.
] 
[Add PackageIndex.dependencyGraph that builds a Graph
Duncan Coutts <duncan@haskell.org>**20080506234326
 Useful for some more tricky queries.
] 
[Add PackageIndex.delete
Duncan Coutts <duncan@haskell.org>**20080506131603
 We occasionally need to remove packages from an index
 eg to restrict the choices of a dependency resolver.
] 
[Remove a test for the specific kind of exception for nhc98 compatibility
Duncan Coutts <duncan@haskell.org>**20080506102804
 This was the check for ghc-pkg failing. We cannot check for the
 exception being an ExitException since that assumes ghc's
 representation of the Exception type, whereas nhc98 defines:
 type Exception = IOError
] 
[Cope better with ghc bug #2201, display a better error message
Duncan Coutts <duncan@haskell.org>**20080505085746
 Otherwise it can (and does) really confuse people.
 The problem is that the command $ ghc-pkg-6.9 describe '*' --user
 returns a non-zero exit code if the user package db is empty.
 ghc-pkg intends this exit code to tell us if the query returned
 any results (one can use more complex queries as tests) but Cabal
 interprets it as failure. Indeed we cannot distinguish it from
 any other kind of failure from ghc-pkg.
] 
[Add PackageIndex.dependencyCycles
Duncan Coutts <duncan@haskell.org>**20080504131626
 Finds any cycles (strongly connected components) in the dependencies
 of set of packages. This is useful for checking the correctness of
 installation plans.
] 
[Change dependencyInconsistencies to not take the pseudo top package
Duncan Coutts <duncan@haskell.org>**20080504130802
 The one case where we need the pseudo top package we can use
 PackageIndex.insert instead to get the same effect and there
 are other cases in cabal-install where we do not want a pseudo
 top package.
] 
[Reverse the order of the args to PackageIndex.insert
Duncan Coutts <duncan@haskell.org>**20080504130317
 To take the index last like the other functions and like Data.Map.
 It is actually more convenient that way round.
] 
[Revert the change about the --internal flag and a warning about haddock
Duncan Coutts <duncan@haskell.org>**20080501223131
 Just a bit of confusion over the behaviour of the --executable flag.
] 
[Document --internal in Cabal.xml
Joachim Breitner <mail@joachim-breitner.de>**20080501153356] 
[With --executable, --internal just adds --ignore-all-exports
Joachim Breitner <mail@joachim-breitner.de>**20080501152544] 
[Implement --internal flag
Joachim Breitner <mail@joachim-breitner.de>**20080501152421
 Passing --internal to the haddock stage does these things:
  * Does not pass --hide parameter to haddock
  * Passes --ignore-all-exports parameter
  * Appends "(internal documentation)" to the title
] 
[Add an --internal flag to HaddockFlags
Joachim Breitner <mail@joachim-breitner.de>**20080501145103] 
[Revert the other `fmap` to (.)
Malcolm.Wallace@cs.york.ac.uk**20080501110006
 To avoid needing a non-H'98 instance of Functor for (->).
] 
[Revert one change of (.) to fmap. It was not necessary and broke nhc98.
Duncan Coutts <duncan@haskell.org>**20080501104620
 The other one was needed as we changed a type from Bool to Maybe Bool.
] 
[Add help command as per ticket #272
Duncan Coutts <duncan@haskell.org>**20080430133740
 "cabal help" behaves like "cabal --help"
 "cabal help cmd" behaves like "cabal cmd --help"
 Should still work with command line completion.
] 
[Change handling of bool command line args to allow an unset state
Duncan Coutts <duncan@haskell.org>**20080429201123
 For bool valued flags we were always producing the command line
 string corresponding to a false flag value, even if the flag was
 not set. For example we'd always get "--disable-shared".
 It is important for cabal-install to be able to take an empty set
 of flags, override a few flags and turn the flags back into
 command line strings without getting a lot of extra defaults.
 Partly this is because we have to work with older versions of the
 Cabal library command line which does not recognise the new options.
] 
[Remove the feature for highlighting the default cases in --help output
Duncan Coutts <duncan@haskell.org>**20080429191206
 Turns out it doesn't help us much because in many cases the initial/default
 flags are actually empty so we cannot identify the default values.
] 
[Make the old test code compile
Duncan Coutts <duncan@haskell.org>**20080428225729
 Still a lot of bit rot, many of the full tests fail due to changed paths
] 
[Fix license parsing
Duncan Coutts <duncan@haskell.org>**20080428192255
 Spotted by the testsuite which I'm trying to resurrect.
] 
[Fix fix for #224.
Thomas Schilling <nominolo@gmail.com>**20080426164537
 
 Changing from list of Dependencies to Maps resulted in the wrong Monoid 
 instance being used.  I'd still like to be able to run a test suite on 
 this but that'd require a lot more work to do properly...
] 
[When multiple specifying list fields in the same section combine them
Duncan Coutts <duncan@haskell.org>**20080423201519
 eg if you had:
 extensions: Foo
 extensions: Bar, Baz
 then previously we only ended up with [Bar, Baz]. Now we get them all.
 Only applies to list fields, for single fields the second value is taken
 and the first is silently discarded. This isn't good of course but the
 fix is harder since we're not in a context where we can report errors.
 Really we should just declare up front what kind of field it is and
 inherit the right behaviour automagically, either duplicates disallowed
 or allowed and combined with mappend.
] 
[Normalise file names in warning messages
Duncan Coutts <duncan@haskell.org>**20080423190457
 We already do this for error messages.
] 
[Fix the check for -XFooBar ghc-options flags to be more permissive
Duncan Coutts <duncan@haskell.org>**20080423190243
 Previously we rejected all such flags but that posed the problem that older
 versions of Cabal, like 1.1.6 did not understand new extensions so we
 could not actually follow the advice and use the extenion. So now we only
 warn about -X flags if they refer to old extensions that Cabal 1.1.6 knew
 about. If the .cabal file specifies cabal-version: >= 1.2 or similar
 (anything that excludes 1.1.6) then we warn about all -X flags.
] 
[Add checks for unknown OS Arch and Compiler names
Duncan Coutts <duncan@haskell.org>**20080423151410
 They're ok locally but for distribution they need to be known.
] 
[Package check now take a GenericPackageDescription
Duncan Coutts <duncan@haskell.org>**20080423150354
 Unfortunately in some cases we only have a already-configured
 PackageDescription to we have to expose a checkConfiguredPackage.
 We should refactor things so that we keep all the information
 even in a configured PackageDescription.
] 
[Make warning messages show the file name
Duncan Coutts <duncan@haskell.org>**20080422141909] 
[Update UTF8 code
Duncan Coutts <duncan@haskell.org>**20080422141539
 Some code and test cases taken from the utf8-string package.
 Updated copyright notice appropriately (I think).
] 
[fix import for nhc98
Malcolm.Wallace@cs.york.ac.uk**20080422133009] 
[Don't nub extra-libs in unionBuildInfo
Duncan Coutts <duncan@haskell.org>**20080420192312
 It's possible that we sometimes need to list the same library
 more than once if there are circular symbol references.
] 
[Fix unionBuildInfo
Duncan Coutts <duncan@haskell.org>**20080420180520
 Fix ticket #264 to use nub only on the fields which are treated as sets.
 Probably we should be using the right types and mappend for each field.
 Change to construct a new value from scratch rather than overriding one
 of the two args. This helps to make sure we're updating all the field
 as we get a warning if we miss any. Turns out we were missing the ghc
 profiling and shared libs options which meant they were getting dropped.
 That had the effect of ghc-prof-options: in .cabal files being ignored.
 Thanks to 'midfield' from #haskell for spotting this.
] 
[Add newtype FlagName and FlagAssignment type alias
Duncan Coutts <duncan@haskell.org>**20080415204854
 and use them in the appropriate places.
] 
[Add PackageIndex.insert and reverse merge/mappend
Duncan Coutts <duncan@haskell.org>**20080415203637
 Packages in the second argument to merge now mask those in the first.
] 
[Make finalizePackageDescription use CompilerId type
Duncan Coutts <duncan@haskell.org>**20080413224111
 Use the proper data type rather than a tuple (CompilerFlavor, Version)
] 
[Fix #224.  We do not yet warn if the user specified a dependency that
Thomas Schilling <nominolo@gmail.com>**20080413182659
 did not occur in the package (it is just silently ignored.)
] 
[Add 'readP_to_E' function that takes the longest parse.
Thomas Schilling <nominolo@gmail.com>**20080413182042] 
[Add simple test case for the dependency resolution case.  This should
Thomas Schilling <nominolo@gmail.com>**20080413132002
 go into the test suite one day.
] 
[Fix/Add documentation.
Thomas Schilling <nominolo@gmail.com>**20080413131839] 
[Change dependency resolution algorithm.
Thomas Schilling <nominolo@gmail.com>**20080413131807
 
 There were two reasons to do this.  Firstly, this formulation makes it
 easier to add the --constraint command line flag that adds additional
 constraints on the packages that should be used.
 
 Secondly, with the orgininal algorithm it was possible to satisfy the
 constraint "foo < 1, foo > 2" if we had two versions of package "foo"
 which each satisfy one constraint.  This patch fixes this by requiring
 the same package to satisfy both constraints (which of course is
 impossible in this case).
] 
[expose ghcOptions
jeanphilippe.bernardy@gmail.com**20080417211221
 This helps finding the options to pass to GHC API in various tools
] 
[expose tryGetConfigStateFile
jeanphilippe.bernardy@gmail.com**20080417180248
 This is needed by Yi to (try to) load an arbitrary
 project.
] 
[fix for #187 -- directory of Paths_packagename is included when looking for source files
Andres Loeh <mail@andres-loeh.de>**20080412204904] 
[Check for the required cabal version early in parsing
Duncan Coutts <duncan@haskell.org>**20080409154655
 Previously we only checked the "cabal-version" field after parsing
 and all other configure processing. If the package really needs a
 later Cabal version it is of course highly likely that parsing or
 configure are going to fail and the user is not going to get the
 helpful error message about the version of Cabal required. So now
 we do the check early during parsing. If a later version is
 required and parsing subsequently fails, we now report the version
 issue, not the subsequent parse error. If parsing succeeds we
 still issue a warning which should be a useful hint to the user if
 subsequent configure processing fails.
] 
[Use relative file paths in .cabal parse error messages
Duncan Coutts <duncan@haskell.org>**20080409154030
 Do this by normalising the file path in the error message
 and when looking for .cabal files, by looking in '.' rather
 than the absolute path of the current directory.
] 
[Remove unused import
Duncan Coutts <duncan@haskell.org>**20080409073352] 
[Fix for detecting ~/.cabal/ dir as a .cabal file
Duncan Coutts <duncan@haskell.org>**20080409073236
 Which happened if you use cabal configure in your home dir.
 Now produced the right error message, or if you actually put
 a cabal project in your home dir, it might actually work.
 Also, do the same fix for findHookedPackageDesc.
] 
[Fix spelling in error message
Duncan Coutts <duncan@haskell.org>**20080408134610] 
[Fix names of profiling libs
Duncan Coutts <duncan@haskell.org>**20080407013449
 I broke this recently when refactoring. Restore the original behaviour.
 Was generating "libHSfoo_p-1.0.a" when it should be "libHSfoo-1.0_p.a".
] 
[TAG 1.5.1
Duncan Coutts <duncan@haskell.org>**20080329181329] 
Patch bundle hash:
a6515671a687e1d4af3085fbe6c9be5ab22055a5