aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2017-06-01 11:56:56 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2017-06-01 11:56:56 -0400
commit5c058d99a26da3639afcbf855eb7b6ca3d628fb3 (patch)
tree0ac7b5c477bfbc273d0d9eb8d0a07fde8e18a5f0 /doc
parent8fa7c51f198cca8516e5e46de114e7dcd6823767 (diff)
expand docs
Diffstat (limited to 'doc')
-rw-r--r--doc/automatic_conflict_resolution.mdwn2
-rw-r--r--doc/git-annex-resolvemerge.mdwn25
2 files changed, 24 insertions, 3 deletions
diff --git a/doc/automatic_conflict_resolution.mdwn b/doc/automatic_conflict_resolution.mdwn
index 095cfde7d..0d4f55a01 100644
--- a/doc/automatic_conflict_resolution.mdwn
+++ b/doc/automatic_conflict_resolution.mdwn
@@ -21,3 +21,5 @@ conflict resolution is designed so that if two or more repositories both get
a merge conflict, and resolve it, the resolved repositories will not
themselves conflict. This is why it doesn't use something nicer, like
perhaps the name of the remote that the file came from.
+
+See also: [[git-annex-resolvemerge]]
diff --git a/doc/git-annex-resolvemerge.mdwn b/doc/git-annex-resolvemerge.mdwn
index d548331a3..b870bab29 100644
--- a/doc/git-annex-resolvemerge.mdwn
+++ b/doc/git-annex-resolvemerge.mdwn
@@ -12,9 +12,28 @@ Resolves a conflicted merge, by adding both conflicting versions of the
file to the tree, using variants of their filename. This is done
automatically when using `git annex sync` or `git annex merge`.
-Note that only merge conflicts that involve an annexed file are resolved.
-Merge conflicts between two files that are not annexed will not be
-automatically resolved.
+Note that only merge conflicts that involve one or more annexed files
+are resolved. Merge conflicts between two files that are not annexed
+will not be automatically resolved.
+
+# EXAMPLE
+
+Suppose Alice commits a change to annexed file `foo`, and Bob commits
+a different change to the same file `foo`.
+
+Merging between them will then fail, and git will present the
+merge conflict as a file `foo` pointing to one version of the
+git-annex symlink, with `git status` indicating that `foo` has an
+unresolved conflict.
+
+Running `git annex resolvemerge` in this situation will resolve the merge
+conflict, by replacing the file `foo` with files named like
+`foo.variant-c696` and `foo.variant-f16a`. One of the files has the content
+that Alice committed, and the other has the content that Bob committed.
+
+The user can then examine the two variants of the file, and either merge
+the two changes into a single file, or rename one of them back to `foo`
+and delete the other.
# SEE ALSO