Commit c5db03cc authored by Duncan Coutts's avatar Duncan Coutts
Browse files

Improve documentation of BuildResult vs BuildStatus

parent 04eb1734
...@@ -114,12 +114,17 @@ import System.Directory ...@@ -114,12 +114,17 @@ import System.Directory
-- (that would make it harder to reproduce the problem sitation). -- (that would make it harder to reproduce the problem sitation).
-- | The 'BuildStatus' of every package in the 'ElaboratedInstallPlan' -- | The 'BuildStatus' of every package in the 'ElaboratedInstallPlan'.
--
-- This is used as the result of the dry-run of building an install plan.
-- --
type BuildStatusMap = Map InstalledPackageId BuildStatus type BuildStatusMap = Map InstalledPackageId BuildStatus
-- | The build status for an individual package. That is, the state that the -- | The build status for an individual package is the state that the
-- package is in prior to initiating a (re)build. -- package is in /prior/ to initiating a (re)build.
--
-- This should not be confused with a 'BuildResult' which is the outcome
-- /after/ building a package.
-- --
-- It serves two purposes: -- It serves two purposes:
-- --
......
...@@ -267,7 +267,12 @@ maybeRepoRemote (RepoSecure r _localDir) = Just r ...@@ -267,7 +267,12 @@ maybeRepoRemote (RepoSecure r _localDir) = Just r
-- * Build results -- * Build results
-- ------------------------------------------------------------ -- ------------------------------------------------------------
-- | A summary of the outcome for building a single package.
--
type BuildResult = Either BuildFailure BuildSuccess type BuildResult = Either BuildFailure BuildSuccess
-- | A summary of the outcome for building a whole set of packages.
--
type BuildResults = Map UnitId BuildResult type BuildResults = Map UnitId BuildResult
data BuildFailure = PlanningFailed data BuildFailure = PlanningFailed
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment