identity: wip push/pull

1 files changed, 9 insertions, 3 deletions

diff --git a/bug/bug_actions.go b/bug/bug_actions.go
index a21db826..6b9135b0 100644
--- a/bug/bug_actions.go
+++ b/bug/bug_actions.go
@@ -8,7 +8,7 @@ import (
 	"github.com/pkg/errors"
 )
 
-// Fetch retrieve update from a remote
+// Fetch retrieve updates from a remote
 // This does not change the local bugs state
 func Fetch(repo repository.Repo, remote string) (string, error) {
 	remoteRefSpec := fmt.Sprintf(bugsRemoteRefPattern, remote)
@@ -23,7 +23,7 @@ func Push(repo repository.Repo, remote string) (string, error) {
 }
 
 // Pull will do a Fetch + MergeAll
-// This function won't give details on the underlying process. If you need more
+// This function won't give details on the underlying process. If you need more,
 // use Fetch and MergeAll separately.
 func Pull(repo repository.ClockedRepo, remote string) error {
 	_, err := Fetch(repo, remote)
@@ -45,7 +45,13 @@ func Pull(repo repository.ClockedRepo, remote string) error {
 	return nil
 }
 
-// MergeAll will merge all the available remote bug
+// MergeAll will merge all the available remote bug:
+//
+// - If the remote has new commit, the local bug is updated to match the same history
+//   (fast-forward update)
+// - if the local bug has new commits but the remote don't, nothing is changed
+// - if both local and remote bug have new commits (that is, we have a concurrent edition),
+//   new local commits are rewritten at the head of the remote history (that is, a rebase)
 func MergeAll(repo repository.ClockedRepo, remote string) <-chan MergeResult {
 	out := make(chan MergeResult)