summaryrefslogtreecommitdiff
path: root/Annex/Branch.hs
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2011-12-12 17:24:12 -0400
committerGravatar Joey Hess <joey@kitenet.net>2011-12-12 17:24:12 -0400
commitb2f934e07ad32cfe44ea1fab2ca154379f30efe8 (patch)
treec29262e917ff174b6ee0ff56d982d541df76f604 /Annex/Branch.hs
parent6edaabd0407287becda24904ed19413a5371979c (diff)
update comment
Diffstat (limited to 'Annex/Branch.hs')
-rw-r--r--Annex/Branch.hs8
1 files changed, 6 insertions, 2 deletions
diff --git a/Annex/Branch.hs b/Annex/Branch.hs
index c657525b1..b79a8975d 100644
--- a/Annex/Branch.hs
+++ b/Annex/Branch.hs
@@ -97,8 +97,8 @@ setIndexRef ref = do
{- Commits the staged changes in the index to the branch.
-
- - Ensures that the branch's index file is first updated to include the
- - current state of the branch, before running the commit action. This
+ - Ensures that the branch's index file is first updated to the state
+ - of the brannch at branchref, before running the commit action. This
- is needed because the branch may have had changes pushed to it, that
- are not yet reflected in the index.
-
@@ -108,6 +108,10 @@ setIndexRef ref = do
- being updated to include it. The result is that the newly pushed
- change is reverted. This race is detected and another commit made
- to fix it.
+ -
+ - The branchref value can have been obtained using getBranch at any
+ - previous point, though getting it a long time ago makes the race
+ - more likely to occur.
-}
commitBranch :: Git.Ref -> String -> [Git.Ref] -> Annex ()
commitBranch branchref message parents = do