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

Add and adjust a few comments on project status

parent f1c84021
......@@ -717,6 +717,11 @@ lookupBuildOutcome = Map.lookup . installedUnitId
-- (using the 'JobControl' to try to cancel in-progress tasks). This behaviour
-- can be reversed to keep going and build as many packages as possible.
--
-- Note that the 'BuildOutcomes' is /not/ guaranteed to cover all the packages
-- in the plan. In particular in the default mode where we stop as soon as
-- possible after a failure then there may be packages which are skipped and
-- these will have no 'BuildOutcome'.
--
execute :: forall m ipkg srcpkg result failure.
(IsUnit ipkg, IsUnit srcpkg,
Monad m)
......
......@@ -132,6 +132,14 @@ import System.Directory
-- errors (ie rebuilding too much or too little), since all the rebuild
-- decisions are made without making any state changes at the same time
-- (that would make it harder to reproduce the problem situation).
--
-- Finally, we can use the dry run build status and the build outcomes to
-- give us some information on the overall status of packages in the project.
-- This includes limited information about the status of things that were
-- not actually in the subset of the plan that was used for the dry run or
-- execution phases. In particular we may know that some packages are now
-- definitely out of date. See "Distribution.Client.ProjectPlanOutput" for
-- details.
------------------------------------------------------------------------------
......@@ -212,7 +220,7 @@ data BuildStatusRebuild =
-- rerun. We record the reason the (re)build is needed.
--
-- The optional registration info here tells us if we've registered the
-- package already, or if we stil need to do that after building.
-- package already, or if we still need to do that after building.
-- @Just Nothing@ indicates that we know that no registration is
-- necessary (e.g., executable.)
--
......@@ -222,9 +230,6 @@ data BuildReason =
-- | The dependencies of this package have been (re)built so the build
-- phase needs to be rerun.
--
-- The optional registration info here tells us if we've registered the
-- package already, or if we stil need to do that after building.
--
BuildReasonDepsRebuilt
-- | Changes in files within the package (or first run or corrupt cache)
......
Markdown is supported
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