Ticket #516: _516_-maintains-a-per_user-index-of-haddock-docs.dpatch

Sun Jun  7 19:05:12 CEST 2009  Andrea Vezzosi <sanzhiyan@gmail.com>
  * #516, maintains a per-user index of haddock docs
  If the haddock-index flag is set it keeps an index 
  of the haddock documentation of the packages in 
  the global and user databases

New patches:

[#516, maintains a per-user index of haddock docs
Andrea Vezzosi <sanzhiyan@gmail.com>**20090607170512
 Ignore-this: 1114f6b944043781c4bf99620573b1cc
 If the haddock-index flag is set it keeps an index 
 of the haddock documentation of the packages in 
 the global and user databases
] {
addfile ./Distribution/Client/Haddock.hs
hunk ./Distribution/Client/Haddock.hs 1
+-----------------------------------------------------------------------------
+-- |
+-- Module      :  Distribution.Client.Haddock
+-- Copyright   :  (c) Andrea Vezzosi 2009
+-- License     :  BSD-like
+--
+-- Maintainer  :  cabal-devel@haskell.org
+-- Portability :  portable
+--
+-- Interfacing with Haddock
+--
+-----------------------------------------------------------------------------
+module Distribution.Client.Haddock 
+    (
+     regenerateHaddockIndex
+    )
+    where
+
+import Data.Maybe (Maybe(..), listToMaybe)
+import Data.List (maximumBy)
+import Control.Monad (Monad(return), sequence, guard)
+import System.Directory (createDirectoryIfMissing, doesFileExist,
+                         renameFile)
+import System.FilePath (FilePath, (</>), splitFileName)
+import Distribution.Package (Package(..))
+import Distribution.Simple.Program (haddockProgram, ProgramConfiguration
+                                   , rawSystemProgram, requireProgramVersion)
+import Distribution.Version (Version(Version), orLaterVersion)
+import Distribution.Verbosity (Verbosity)
+import Distribution.Text (display)
+import Distribution.Simple.PackageIndex(PackageIndex, allPackages,
+                                        allPackagesByName, fromList)
+import Distribution.Simple.Utils (comparing, installDirectoryContents
+                                 , intercalate, warn, withTempDirectory)
+import Distribution.InstalledPackageInfo as InstalledPackageInfo 
+    (InstalledPackageInfo,InstalledPackageInfo_(haddockHTMLs, haddockInterfaces, exposed, package))
+
+regenerateHaddockIndex :: Verbosity -> PackageIndex InstalledPackageInfo -> ProgramConfiguration -> FilePath -> IO ()
+regenerateHaddockIndex verbosity pkgs conf index = do
+      (paths,warns) <- haddockPackagePaths pkgs'
+      case warns of
+        Nothing -> return ()
+        Just m  -> warn verbosity m
+      
+      (confHaddock, _, _) <-
+          requireProgramVersion verbosity haddockProgram
+                                    (orLaterVersion (Version [0,6] [])) conf
+
+      createDirectoryIfMissing True destDir
+
+      withTempDirectory verbosity destDir "htemp" $ \tempDir -> do
+
+        let flags = ["--gen-contents", "--gen-index", "--odir="++tempDir] 
+                    ++ map (\(i,h) -> "--read-interface=" ++ h ++ "," ++ i) paths
+        rawSystemProgram verbosity confHaddock flags
+        renameFile (tempDir </> "index.html") (tempDir </> destFile)
+        installDirectoryContents verbosity tempDir destDir
+      
+  where 
+    (destDir,destFile) = splitFileName index
+    pkgs' = map (maximumBy $ comparing packageId) 
+            . allPackagesByName 
+            . fromList
+            . filter exposed
+            . allPackages
+            $ pkgs
+
+haddockPackagePaths :: [InstalledPackageInfo_ m]
+                       -> IO ([(FilePath, FilePath)], Maybe [Char])
+haddockPackagePaths pkgs = do
+  interfaces <- sequence
+    [ case interfaceAndHtmlPath pkg of
+        Just (interface, html) -> do
+          exists <- doesFileExist interface
+          if exists
+            then return (pkgid, Just (interface, html))
+            else return (pkgid, Nothing)
+        Nothing -> return (pkgid, Nothing)
+    | pkg <- pkgs, let pkgid = InstalledPackageInfo.package pkg ]
+
+  let missing = [ pkgid | (pkgid, Nothing) <- interfaces ]
+
+      warning = "The documentation for the following packages are not "
+             ++ "installed. No links will be generated to these packages: "
+             ++ intercalate ", " (map display missing)
+
+      flags = [ x | (_, Just x) <- interfaces ]
+
+  return (flags, if null missing then Nothing else Just warning)
+
+  where
+    interfaceAndHtmlPath pkg = do
+      interface <- listToMaybe (InstalledPackageInfo.haddockInterfaces pkg)
+      html <- listToMaybe (InstalledPackageInfo.haddockHTMLs pkg)
+      guard (not . null $ html)
+      return (interface, html)
hunk ./Distribution/Client/Install.hs 44
          , upgradableDependencies
          , Progress(..), foldProgress, )
 import Distribution.Client.Fetch (fetchPackage)
+import qualified Distribution.Client.Haddock as Haddock (regenerateHaddockIndex)
 -- import qualified Distribution.Client.Info as Info
 import Distribution.Client.IndexUtils as IndexUtils
          ( getAvailablePackages, disambiguateDependencies )
hunk ./Distribution/Client/Install.hs 92
          ( defaultPackageDesc, rawSystemExit, comparing )
 import Distribution.Simple.InstallDirs
          ( PathTemplate, fromPathTemplate, toPathTemplate
-         , initialPathTemplateEnv, substPathTemplate )
+         , initialPathTemplateEnv, substPathTemplate, systemPathTemplateEnv )
 import Distribution.Package
          ( PackageName, PackageIdentifier, packageName, packageVersion
          , Package(..), PackageFixedDeps(..)
hunk ./Distribution/Client/Install.hs 224
         when (reportingLevel == DetailedReports) $
           storeDetailedBuildReports verbosity logsDir buildReports
 
+        regenerateHaddockIndex installPlan'
+
         symlinkBinaries verbosity configFlags installFlags installPlan'
         printBuildFailures installPlan'
 
hunk ./Distribution/Client/Install.hs 230
   where
+    regenerateHaddockIndex installPlan' = do
+      let regenIndex = and [not . null . filter installedDocs . InstallPlan.toList $ installPlan'
+                             ,UserPackageDB `elem` packageDBs
+                             ,null [() | SpecificPackageDB _ <- packageDBs]
+                           ]
+      when (regenIndex && isJust (flagToMaybe haddockIndex)) $ do
+            installed <- getInstalledPackages verbosity comp packageDBs conf
+            case installed of
+              Nothing -> return () -- warning ?
+              Just index -> do 
+                defaultDirs <- InstallDirs.defaultInstallDirs
+                               ((\(CompilerId x _) -> x) $ compilerId comp)
+                               (fromFlag (configUserInstall configFlags))
+                               True
+                Haddock.regenerateHaddockIndex verbosity index conf 
+                            (substHaddockIndexFileName defaultDirs . fromFlag $ haddockIndex)
+       where
+         installedDocs (InstallPlan.Installed _ (BuildOk DocsOk _)) = True
+         installedDocs _                                            = False
+         haddockIndex = installHaddockIndex installFlags
+         substHaddockIndexFileName defaultDirs template = fromPathTemplate
+                                                        . substPathTemplate env
+                                                        $ template
+    
+           where env = systemPathTemplateEnv (compilerId comp) absoluteDirs
+                 templateDirs   = InstallDirs.combineInstallDirs fromFlagOrDefault
+                                  defaultDirs (configInstallDirs configFlags)
+                 absoluteDirs   = InstallDirs.absoluteInstallDirs' 
+                                  (InstallDirs.compilerToTemplateEnv (compilerId comp) 
+                                   ++ InstallDirs.platformToTemplateEnv (buildPlatform))
+                                  templateDirs
+
     setupScriptOptions index = SetupScriptOptions {
       useCabalVersion  = maybe anyVersion thisVersion (libVersion miscOptions),
       useCompiler      = Just comp,
hunk ./Distribution/Client/Setup.hs 451
 --
 data InstallFlags = InstallFlags {
     installDocumentation:: Flag Bool,
+    installHaddockIndex :: Flag PathTemplate,
     installDryRun       :: Flag Bool,
     installReinstall    :: Flag Bool,
     installOnly         :: Flag Bool,
hunk ./Distribution/Client/Setup.hs 465
 defaultInstallFlags :: InstallFlags
 defaultInstallFlags = InstallFlags {
     installDocumentation= Flag False,
+    installHaddockIndex = Flag . toPathTemplate $ "$datadir" </> "doc" </> "index.html",
     installDryRun       = Flag False,
     installReinstall    = Flag False,
     installOnly         = Flag False,
hunk ./Distribution/Client/Setup.hs 513
           installDocumentation (\v flags -> flags { installDocumentation = v })
           (boolOpt [] [])
 
+      , option [] ["haddock-index"]
+          "Haddock html index file (name template shouldn't use $pkgid)"
+          installHaddockIndex (\v flags -> flags { installHaddockIndex = v })
+          (reqArg' "TEMPLATE" (toFlag.toPathTemplate)
+                              (flagToList . fmap fromPathTemplate))
       , option [] ["dry-run"]
           "Do not install anything, only print what would be installed."
           installDryRun (\v flags -> flags { installDryRun = v })
hunk ./Distribution/Client/Setup.hs 569
 instance Monoid InstallFlags where
   mempty = InstallFlags {
     installDocumentation= mempty,
+    installHaddockIndex = mempty,
     installDryRun       = mempty,
     installReinstall    = mempty,
     installOnly         = mempty,
hunk ./Distribution/Client/Setup.hs 581
   }
   mappend a b = InstallFlags {
     installDocumentation= combine installDocumentation,
+    installHaddockIndex = combine installHaddockIndex,
     installDryRun       = combine installDryRun,
     installReinstall    = combine installReinstall,
     installOnly         = combine installOnly,
hunk ./cabal-install.cabal 57
         Distribution.Client.Dependency.TopDown.Types
         Distribution.Client.Dependency.Types
         Distribution.Client.Fetch
+        Distribution.Client.Haddock
         Distribution.Client.HttpUtils
         Distribution.Client.IndexUtils
         Distribution.Client.Install
}

Context:

[Fix use of deprecated version constructors
Duncan Coutts <duncan@haskell.org>**20090604180500] 
[Only report preferred new versions of cabal-install are available
Duncan Coutts <duncan@haskell.org>**20090604175726
 That is, use the "preferred-versions" mechanism when deciding
 whether there is a new version available. This would allow us to
 upload a new version without everyone immediately being told to
 get it and try it out.
] 
[Make cabal upload/check print out the error messages reported by the server
Duncan Coutts <duncan@haskell.org>**20090604124836
 The code to do it was already there but we were checking for the
 mime type text/plain using just (==) when in fact the server reports  
   text/plain; charset="ISO-8859-1"
 so we have to parse the field a bit better (still a bit of a hack).
] 
[Require latest Cabal lib version
Duncan Coutts <duncan@haskell.org>**20090603102312] 
[Improve formatting of cabal check output
Duncan Coutts <duncan@haskell.org>**20090603102254] 
[Only apply preferences to base if its version is unbounded above
Duncan Coutts <duncan@haskell.org>**20090603101623
 Fixes ticket #485. This means that for constraints like:
     build-depends: base >= 3 && < 5
 we will pick version 4. However we will continue to apply the
 version 3 preference for things like:
     build-depends: base >= 3
 Where there is no upper bound on the version. Note that we now
 also ignore preferences for base given on the command line.
 We should implement #483 to split prefs from shims.
] 
[Improve the parse error message for package name/deps
Duncan Coutts <duncan@haskell.org>**20090321154623
 Make it clear that it's the specification of the package name that
 is at fault rather than the package to which the name refers.
] 
[Debian in their wisdom decided to build network against parsec 3.
Duncan Coutts <duncan@haskell.org>**20090308142925
 So checking for parsec 2 fails. We don't strictly need parsec, it's
 just a dependency of network, so remove the check.
] 
[Simplify version ranges before printing in error messages
Duncan Coutts <duncan@haskell.org>**20090531191346
 Part of ticket #369
] 
[Use new top handler, should get better error messages
Duncan Coutts <duncan@haskell.org>**20090531190318] 
[Fix uses of deprecated stuff
Duncan Coutts <duncan@haskell.org>**20090531190239] 
[New development branch, version 0.7
Duncan Coutts <duncan@haskell.org>**20090531184336
 Update to development version of Cabal
] 
[Solaris 9 /bin/sh doesn't like the ! syntax in bootstrap.sh
Duncan Coutts <duncan@haskell.org>**20090318091730] 
[Clarify the instructions in the README and bootstrap.sh
Duncan Coutts <duncan@haskell.org>**20090315125407
 Addresses the complaint in ticket #523.
] 
[Select Configuration file via env var CABAL_CONFIG.
Paolo Losi <paolo.losi@gmail.com>**20090223005251
 Ignore-this: 26e5ded85cb69cb3a19cd57680a8a362
] 
[Update tar code based on new tar package
Duncan Coutts <duncan@haskell.org>**20090301174949] 
[Actually does compile with unix-1.0 that comes with ghc-6.6
Duncan Coutts <duncan@haskell.org>**20090221154605
 ghc-6.6.1 came with unix-2.1
] 
[TAG 0.6.2
Duncan Coutts <duncan@haskell.org>**20090219130720] 
[Extend the invariant on the Constraints ADT
Duncan Coutts <duncan@haskell.org>**20081219192309
 It now carries around the original version of the database
 purely so that it can do a much more extensive consistency
 check. Packages are never gained or lost, just transfered
 between pots in various slightly tricky ways.
] 
[Add extra assertion into the top down dep planner
Duncan Coutts <duncan@haskell.org>**20090218234650] 
[Update the README
Duncan Coutts <duncan@haskell.org>**20090219130705] 
[Add missing other-modules
Duncan Coutts <duncan@haskell.org>**20090218235206] 
[Bump version to 0.6.2
Duncan Coutts <duncan@haskell.org>**20090218231016] 
[Update changelog for 0.6.2 release
Duncan Coutts <duncan@haskell.org>**20090218230918] 
[Tweaks to the bootstrap script
Duncan Coutts <duncan@haskell.org>**20090218223943
 Update Cabal lib version to 1.6.0.2
 Implement a couple shell script coding style recommendations.
] 
[Disable the upgrade command for now.
Duncan Coutts <duncan@haskell.org>**20090218221752] 
[Add warnings in the case that no remote servers have been specified
Duncan Coutts <duncan@haskell.org>**20090216181424
 It's not strictly an error but it can be rather confusing.
] 
[Put an explanation of the config file format at the top in comments.
Duncan Coutts <duncan@haskell.org>**20090215190817] 
[Change the field order in the initial config file.
Duncan Coutts <duncan@haskell.org>**20090215190727
 Also update the name of one excluded field.
] 
[Put the default logging and reporting setting in the initial config file.
Duncan Coutts <duncan@haskell.org>**20090215190524] 
[Complete the implementation of --build-summary=TEMPLATE
Duncan Coutts <duncan@haskell.org>**20090215190254
 Actually respect the new flag. It's actually a list of template files
 and all specified files get written to. This allows us to specify
 a default build log file and also have the user write to extra ones.
 The summary file template can contain $pkgid $compiler etc.
] 
[Rearrange user interface for build logging
Duncan Coutts <duncan@haskell.org>**20090215185800
 The new options (as described in ticket #501) are:
   --build-summary=TEMPLATE
   --build-log=TEMPLATE
   --remote-build-reporting=LEVEL
   where LELVEL `elem` [none,anonymous,detailed]
] 
[always check environment variables for HTTP proxy first
Ganesh Sittampalam <ganesh.sittampalam@credit-suisse.com>**20090210230736] 
[Improve the cabal update notice
Duncan Coutts <duncan@haskell.org>**20090209211844] 
[Don't report that packages are cached at the default verbosity level
Duncan Coutts <duncan@haskell.org>**20090209201228
 It's just not that useful. Report it at -v verobisty level, and
 change the text and formatting.
] 
[Fix #490, unpack now gives a proper error message.
Andrea Vezzosi <sanzhiyan@gmail.com>**20090208165240
 Ignore-this: 358dd291624f8858a52ae2ff27a7e0c2
] 
[Use the new withTempDirectory function
Duncan Coutts <duncan@haskell.org>**20090202012255
 In particular it means that install will unpack packages into
 different temp dirs on each invocation which means that running
 install on the same package for different compilers at the same
 time should not clash. This is quite useful for testing.
] 
[Add compat withTempDirectory function
Duncan Coutts <duncan@haskell.org>**20090202011917
 This is already in Cabal HEAD but we cannot use that yet
] 
[Add homepage and bug-reports fields to .cabal file
Duncan Coutts <duncan@haskell.org>**20090201225021] 
[Remove the prefernece and cabal lib version flags from the InstallFlags
Duncan Coutts <duncan@haskell.org>**20090126012412
 They are now in the ConfigExFlags instead.
] 
[Change the install and configure modules to use the extended config flags
Duncan Coutts <duncan@haskell.org>**20090126011942] 
[Add ConfigExFlags into the configure, install and upgrade commands
Duncan Coutts <duncan@haskell.org>**20090126010918
 Not yet passed all the way through.
] 
[Add ConfigExFlags and related command
Duncan Coutts <duncan@haskell.org>**20090126010132
 This is for configure flags that we use in the configure command in the
 cabal command line tool that are not present in runghc Setup configure
 command line interface. These are flags that we are moving from the
 install command, so that we can also use them for the configure command.
 Initially it's just the flags for specifying package version preferences
 and  the cabal library version. We'll add constraints later.
] 
[Remove unnecessary qualified use of ConfigFlags
Duncan Coutts <duncan@haskell.org>**20090126003951] 
[Make configure use the dependency resolver
Duncan Coutts <duncan@haskell.org>**20090125170951
 This means it makes smarter decisions and also decions that are more
 consistent with those taken by the install command.
] 
[Update HTTP dep in the bootstrap script
Duncan Coutts <duncan@haskell.org>**20090123160700] 
[Improve error message when ghc or ghc-pkg are mismatched or not found 
Duncan Coutts <duncan@haskell.org>**20090123160550] 
[Don't use grep -e, solaris does not like it
Duncan Coutts <duncan@haskell.org>**20090123160443] 
[Fix some FIXMEs and do some TODOs in the list command
Duncan Coutts <duncan@haskell.org>**20090123004810
 Now properly prints if the haddock docs are installed and if the
 tarball is cached. It did print them before but it was lying.
] 
[Add initial implementation of cabal info
Duncan Coutts <duncan@haskell.org>**20090119025202
 It provides more detailed information on a particular package.
 Still a few TODOs. Fixes #361, #449 and #456.
] 
[Only print the config file location for the global --help
Duncan Coutts <duncan@haskell.org>**20090116175900] 
[Update to using HTTP-4000.x
Duncan Coutts <duncan@haskell.org>**20090116135646
 This should fix a long-standing bug with http proxies (ticket #352)
 It should also make downloads faster, or at least use less memory.
] 
[Parse compiler field from old config files correctly
Duncan Coutts <duncan@haskell.org>**20090116002851
 Really old versions of cabal-install generated a default config
 containing "compiler: GHC". Sadly the new way we generate the
 config file parser from the command line parser means we end up
 with a case-sensitive parser as it only matches the exact
 command line flags. So we hack it and add in a traditional
 parser for that field only. Really the command line and config
 file infrastructure needs rewriting again. Sigh.
] 
[Improve the printing of config file field parse error messages
Duncan Coutts <duncan@haskell.org>**20090116001421] 
[Read install dirs correctly from old-style .cabal/config files
Duncan Coutts <duncan@haskell.org>**20090116001321
 Should fix ticket #365
] 
[Note in the README that zlib needs the zlib C lib package
Duncan Coutts <duncan@haskell.org>**20090116000541] 
[Traditional /bin/sh portability fixes for bootstrap.sh
Duncan Coutts <duncan@haskell.org>**20090115113227] 
[More improvments to the bootstrap.sh script
Duncan Coutts <duncan@haskell.org>**20090115110612] 
[Rewrite the bootstrap.sh script
Duncan Coutts <duncan@haskell.org>**20090115102210
 Hopefully more useful and more robust. In particular it does not
 download and install packages where suitable versions are already
 installed. It also checks for deps.
] 
[Don't add installed constraints system packages that are not installed
Duncan Coutts <duncan@haskell.org>**20090114143540
 In particular fixes a problem (ticket #439) where we required the
 installed version of ghc-prim with compilers that do not have that
 package such as ghc-6.8 and older, hugs, nhc, lhc etc.
] 
[cabal update now reports if a newer version of cabal-install is available
Duncan Coutts <duncan@haskell.org>**20090114133220] 
[Warn if a package index from a remote repo is 15 days or older
Duncan Coutts <duncan@haskell.org>**20090114124827
 For example it will print:
 Warning: The package list for 'hackage.haskell.org' is 16 days old.
 Run 'cabal update' to get the latest list of available packages.
] 
[Don't display the category in cabal list output
Duncan Coutts <duncan@haskell.org>**20090114003549
 It is probably not sufficiently useful to justify the space it takes.
] 
[In cabal list, always display available and installed versions
Duncan Coutts <duncan@haskell.org>**20090114003329
 Previously we omitted the line if it was not installed, or was
 not available. However that confused people because it was not
 obvious that it would list both. Now it shows something like:
  * foo
        Latest version available: 1.0
        Latest version installed: [ Not installed ]
] 
[Print the location of the config file in the global --help
Duncan Coutts <duncan@haskell.org>**20090113192215
 Ticket #413
] 
[Improve the cabal --help output
Duncan Coutts <duncan@haskell.org>**20090113192058
 Put the general info message at the top and make the explanation of
 installing a hackage package somewhat clearer.
] 
[Display examples in cabal install --help
Duncan Coutts <duncan@haskell.org>**20090113161426
 Examples: 
   cabal install                     Package in the current directory
   cabal install foo                 Package from the hackage server
   cabal install foo-1.0             Specific version of a package
   cabal install 'foo < 2'           Constrained package version
] 
[Print a newline after entering upload password
Duncan Coutts <duncan@haskell.org>**20090113142604
 So we end up with:
   Hackage password: 
   Uploading test.tar.gz...
 rather than:
   Hackage password: Uploading test.tar.gz...
] 
[Respect the --package-db flag when compiling Setup.hs
Duncan Coutts <duncan@haskell.org>**20081221184755
 Fixes ticket #394.
] 
[Use a more precise package substitution test in improvePlan
Duncan Coutts <duncan@haskell.org>**20081219215922
 This is where we take a valid plan and we "improve" it by swapping
 installed packages for available packages wherever possible. This
 change is to the condition we use in deciding if it is safe to use
 the installed package in place of a reinstall. Previously we checked
 that the dependencies of the installed version were exactly the same
 as the dependencies we were planning to reinstall with. That was
 valid but rather conservative. It caused problems in some situations
 where the installed package did not exactly match the available
 package (eg when using development versions of a package or of ghc).
 What we do now is test if the extra constraints implied by selecting
 the installed version are consistent with the existing set of
 constraints. This involves threading the constraint set around. In
 theory this should even cope with adding additional packages to the
 plan as a result of selecting an installed package.
] 
[Use installed constraints instead of hiding versions of the base package
Duncan Coutts <duncan@haskell.org>**20081219193740
 We want to stop cabal-install from accidentally trying to upgrade
 the base package since this doesn't work in most cases. We used to
 achieve that by deleting the base package from the available package
 index. We now do it by leaving the package index as is and instead
 adding a constraint that we pick only an installed version of base.
 This is a nicer hack and has the potential to give better error
 messages.
] 
[Fix constraint set handling for installed constraints
Duncan Coutts <duncan@haskell.org>**20081219182328
 A rather subtle bug. The code was actually correct but the transitionsTo
 assertion was not accounting for a transition between the case where
 a package's available version had been excluded and then the whole thing
 got excluded by a version constraint. It counted one side as a loss
 without a corresponding gain on the other side.
] 
[Add a install/upgrade --preference='foo < 2' flag
Duncan Coutts <duncan@haskell.org>**20081218213849
 This behaves just like the preferred-versions file in the hackage index
 but it can be specified on the command line or in a config file.
] 
[Generalise the way preferences are specified to the resolver
Duncan Coutts <duncan@haskell.org>**20081218204917
 We still provide a default global policy, but now we give a
 list of per-package preferences which can be on the version
 or installed state. Later preferences override earlier ones.
] 
[Workaround for a url parsing bug that breaks http proxies that need auth
Duncan Coutts <duncan@haskell.org>**20081218165541
 Diagnosis and patch from Valery V. Vorotyntsev.
] 
[Implement cabal install --constraint=
Duncan Coutts <duncan@haskell.org>**20081216235032
 Connect up the existing user interface with the new dep resolver api.
] 
[Have the dep resolver take constraints and targets separately
Duncan Coutts <duncan@haskell.org>**20081216233446] 
[Add PackageInstalledConstraint to the PackageConstraint type
Duncan Coutts <duncan@haskell.org>**20081215224538
 This should be useful for things like preventing upgrading
 the base package for ghc.
] 
[A bit more renaming in the top down resolver
Duncan Coutts <duncan@haskell.org>**20081215224324] 
[Take preferences into account in the bogus resolver
Duncan Coutts <duncan@haskell.org>**20081215221728] 
[Mostly renaming and trivial refactoring
Duncan Coutts <duncan@haskell.org>**20081215221034] 
[Change the dep resolver interface to pass constraints separately from targets
Duncan Coutts <duncan@haskell.org>**20081215215634
 This lets us specify constraints for packages that are not targets.
] 
[Rename and rearrange the PackagePreferences type
Duncan Coutts <duncan@haskell.org>**20081215204836] 
[Don't re-export PackageName from Distribution.Client.Dependency
Duncan Coutts <duncan@haskell.org>**20081215203617
 It used to be a type alias.
] 
[Use the Platform type rather than passing around the OS and Arch separately
Duncan Coutts <duncan@haskell.org>**20081215202856] 
[Bump version to 0.6.1
Duncan Coutts <duncan@haskell.org>**20081210224713] 
[Tidy up the unpack code
Duncan Coutts <duncan@haskell.org>**20081210223633
 Also fix a bug for tar files that contain entries for files
 without preceding entries for the directories they are in.
] 
[Clean up the code in Main
Duncan Coutts <duncan@haskell.org>**20081210223242
 Make the names more regular and set up the various flags
 in a more regular way.
] 
[Use (\_ -> []) instead of mempty to avoid funky Monoid instance
Duncan Coutts <duncan@haskell.org>**20081210223106
 This would let us build with ghc-6.4 or nhc if it were not for other issues.
] 
[Fix warning aobut -fffi in OPTIONS pragma
Duncan Coutts <duncan@haskell.org>**20081203005449] 
[Mention where files get downloaded to at verbosity level verbose
Duncan Coutts <duncan@haskell.org>**20081203004427] 
[Implement 'cabal unpack' command as in #390
Andrea Vezzosi <sanzhiyan@gmail.com>**20081113185923] 
[Remove use of tabs
Duncan Coutts <duncan@haskell.org>**20081122163527] 
[Put explicit lower bound on version of base
Duncan Coutts <duncan@haskell.org>**20081122163151
 It does not build with ghc-6.4.2, missing Functor instance for Either.
] 
[Use a more general fix for "cabal install base"
Duncan Coutts <duncan@haskell.org>**20081122163026
 It's not specific to LHC. Normally we prevent upgrading of base
 since it's unlikely to work and would normally be accidental.
 However when the user explicitly asks to upgrade base then we
 let them do that and they can keep the pieces when it breaks.
] 
[Warn about use of tabs
Duncan Coutts <duncan@haskell.org>**20081122154309] 
[Only send the base file name when uploading tarballs
Duncan Coutts <duncan@haskell.org>**20080903230334
 The server should ignore the dir part anyway but there's no
 need to send it in the first place.
] 
[Slightly better lhc support.
Lemmih <lemmih@gmail.com>**20081121034338
 Ignore-this: 9f51f465aa87d1c6677ca492f877ecd6
] 
[TAG 0.6.0
Duncan Coutts <duncan@haskell.org>**20081011195420] 
[Bump version to 0.6.0
Duncan Coutts <duncan@haskell.org>**20081011195314] 
[Improve the README, better install instructions
Duncan Coutts <duncan@haskell.org>**20081011185919
 And slightly better intro guide to the main commands.
] 
[Bump versions of deps in the bootstrap script
Duncan Coutts <duncan@haskell.org>**20081011184937] 
[Add Eq for a couple types in the anon build reports
Duncan Coutts <duncan@haskell.org>**20081011184825] 
[Drop silly export
Duncan Coutts <duncan@haskell.org>**20081011184805] 
[Apparnetly builds with unix-2.0 which is what came with ghc-6.6
Duncan Coutts <duncan@haskell.org>**20081010234836] 
[Fix the -i dir for compiling Setup.hs when it's the current dir
Duncan Coutts <duncan@haskell.org>**20081010234558
 map "" to "."
] 
[Tidy up the preferred-versions file parser
Duncan Coutts <duncan@haskell.org>**20081010070105] 
[Bump version number and dependencies
Duncan Coutts <duncan@haskell.org>**20081010065854] 
[Relax deps to build with ghc-6.10
Duncan Coutts <duncan@haskell.org>**20081007230701] 
[Handle build reports with missing logs better
Duncan Coutts <duncan@haskell.org>**20081007230635] 
[Add DownloadFailed as a possible failure for installation
Duncan Coutts <duncan@haskell.org>**20081007230418
 Should now be caught during installing a bunch of packages
 and not cause immediate overall failure. It should instead
 be treated like any other package build failure and be
 reported at the end and only affect other dependent builds.
] 
[Fix search paths for compiling Setup.hs scrips
Duncan Coutts <duncan@haskell.org>**20081007213630
 and in particular for bootstrapping the Cabal lib.
] 
[Fix selecting paired packages
Duncan Coutts <duncan@haskell.org>**20081007062930
 Previously when we selected base 4 (and as a consequence
 slected base 3 too) we didn't properly trace the dependencies
 of base 3 so if nothing actually required base 3 then we ended
 up with base 3 in the solution but not with syb which it
 depends on. Consequently the solution was invalid.
 Now we select the paired package properly (hopefully).
] 
[Take preferred versions into account in dependency planning
Duncan Coutts <duncan@haskell.org>**20081006055129
 This means we can now globally prefer base 3 rather than 4.
 However we need to be slightly careful or we end up deciding
 to do silly things like rebuild haskell98 against base 3.
 That would happen because the h98 package doesn't constrain
 the choice to one or the other and we would prefer base 3.
 So we have to add that we really prefer whatever it uses
 currently (if any).
] 
[Pass the package suggested version constraints through to the resolver
Duncan Coutts <duncan@haskell.org>**20081006042758
 Not used yet.
] 
[Fix selection of paired packages
Duncan Coutts <duncan@haskell.org>**20081006040616] 
[Read preferred versions from the package index
Duncan Coutts <duncan@haskell.org>**20081006030259
 From a file named 'preferred-versions' in the 00-index.tar.gz
 If there are several they are combined. Contents is like:
 base < 4
 one suggested version constraint per line.
] 
[Refactor and update the hackage index reading code
Duncan Coutts <duncan@haskell.org>**20081005202747] 
[Print more details about what is to be installed with -v
Duncan Coutts <duncan@haskell.org>**20081005075556
 Reports if installs are new or reinstalls and for reinstalls
 prints what dependencies have changed.
] 
[When finalising paired packages, cope with there being multiple choices
Duncan Coutts <duncan@haskell.org>**20081005053821
 For ordinary packages we selected a single version which means
  we added an equality constraint. As a consequence we used to
 assume there was only one version left when finalising. For
 paired packages there may be two versions left if the package
 did not directly constrain the choice to just one. If there is
 more than one version remaining then we have to pick between
 them. At the moment we still pick the highest version, but
 later we can take a global preference or polciy into account.
] 
[When selecting paired packages, select both.
Duncan Coutts <duncan@haskell.org>**20081005053804] 
[Handle constraints on paired packages
Duncan Coutts <duncan@haskell.org>**20081005051919
 The trick is that when applying constraints to paired
 packages, the constraint has to exclude both packages at
 once. We exclude the pair together or not at all. If it
 would only exclude one then we discard the constraint.
] 
[Add the notion of paired packages to the Constraints ADT
Duncan Coutts <duncan@haskell.org>**20081005013141
 Packages like base-3 and base-4 are paired. This means they are
 supposed to be treated equivalently in some contexts. Paired
 packages are installed packages with the same name where one
 version depends on the other.
] 
[Make InstalledPackage an instance of PackageFixedDeps
Duncan Coutts <duncan@haskell.org>**20081005012741] 
[Add the glue code to actully report excluded packages
Duncan Coutts <duncan@haskell.org>**20081005001400
 Now displayed in the output of install --dry-run -v
] 
[Have Constraints.constrain report the excluded packages
Duncan Coutts <duncan@haskell.org>**20081004235006
 Each time we apply a constraint we can end up excluding some
 extra package. Report that list of packages because it is
 quite interesting information to get insight into what the
 resolver is actually doing.
] 
[Separate the construction of the exclusion list from its use
Duncan Coutts <duncan@haskell.org>**20081004234421
 Previously directly inserted packages into the excluded package
 list. Now we generate a list of them and then add them. We want
 the list of newly excluded packages separately because it is
 interesting information to report to the user when -v is on.
] 
[Generalise the logging of selected and discarded packages
Duncan Coutts <duncan@haskell.org>**20081004232555
 Allow for selecting several packages in one go.
 Currently when we select a package we only list the over versions
 of the same package that that excludes, and not the other packages
 we exclude by applying the dependency constraints of the selected
 package. In future we would like to do that so we now report the
 package name of discards not just the version. Though we do group
 by the package name to avoid too much repition.
] 
[Fix infinite loop in the TopDown dependency resolver
Andrea Vezzosi <sanzhiyan@gmail.com>**20080925181441
 The loop occurred only if a package depended on another one
 with the same name, e.g. base-3.0.3.0 <- base-4.0.0.0
] 
[small improvements to bootstrap
Duncan Coutts <duncan@haskell.org>**20080926214828
 patch sent in by brian0, ticket #357
] 
[Update to the development version of the Cabal lib
Duncan Coutts <duncan@haskell.org>**20080831225243
 The branch of cabal-install that tracks Cabal-1.4 now lives at
 http://darcs.haskell.org/cabal-branches/cabal-install-0.5/
] 
[Allow use of curl in bootstrap.sh
Duncan Coutts <duncan@haskell.org>**20080826233400
 Patch from jsnx. Fixes ticket #343. Also, use "cd blah; cd .."
 instead of "pushd blah; popd" as some shells lack pushd/popd
] 
[Relax version constraint on unix package
Duncan Coutts <duncan@haskell.org>**20080826232851
 Allows building with ghc-6.6.1
] 
[Use mplus not mappend for combining tar filename checks
Duncan Coutts <duncan@haskell.org>**20080826232606
 mappend would join the error messages in the case that both
 checks failed. Also the monoid instance was new in base 3.
] 
[TAG 0.5.2
Duncan Coutts <duncan@haskell.org>**20080826214238] 
Patch bundle hash:
93232bfbc76237144cc754fc3cc9924aef1fe271