[WIP/RFC 13/13] Documentation: Preliminary docs on 'git notes merge'
Signed-off-by: Johan Herland <johan@herland.net>
---
Documentation/git-notes.txt | 26 ++++++++++++++++++++++++++
1 files changed, 26 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index ce0ea03..f4ad4cc 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -14,6 +14,7 @@ SYNOPSIS
'git notes' append [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
'git notes' edit [<object>]
'git notes' show [<object>]
+'git notes' merge [-v | -q] [-X <strategy> ] <notes_ref>
'git notes' remove [<object>]
'git notes' prune [-n | -v]
@@ -83,6 +84,15 @@ edit::
show::
Show the notes for a given object (defaults to HEAD).
+merge::
+ Merge the given notes ref into the current notes ref.
+ This will try to merge the changes made by the given
+ notes ref (called "remote") since the merge-base (if
+ any) into the current notes ref (called "local").
++
+If conflicts arise (and a strategy for auto-resolving conflicting notes
+(see the -X/--resolve option) is not given, the merge fails (TODO).
+
remove::
Remove the notes for a given object (defaults to HEAD).
This is equivalent to specifying an empty note message to
@@ -132,8 +142,24 @@ OPTIONS
Do not remove anything; just report the object names whose notes
would be removed.
+-X <strategy>::
+--resolve=<strategy>::
+ When merging notes, resolve notes conflicts using the given
+ strategy. The following strategies are recognized: "manual"
+ (default), "ours", "theirs" and "union". "ours" automatically
+ resolves conflicting notes in favor of the local version (i.e.
+ the current notes ref). "theirs" auto-resolves notes conflicts
+ in favor of the remote version (i.e. the given notes ref being
+ merged into the current notes ref). "union" auto-resolves
+ notes conflicts by concatenating the local and remote versions.
+
+-q::
+--quiet::
+ When merging notes, operate quietly.
+
-v::
--verbose::
+ When merging notes, be more verbose.
When pruning notes, report all object names whose notes are
removed.
--
1.7.2.220.gea1d3
Johan Herland <johan@herland.net>