notes: add notes.mergeStrategy option to select default strategy

Teach git-notes about "notes.mergeStrategy" to select a general strategy
for all notes merges. This enables a user to always get expected merge
strategy such as "cat_sort_uniq" without having to pass the "-s" option
manually.

Signed-off-by: Jacob Keller <jacob.keller@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 9a6140b81ca1a006806b6077054ab36f4ecc9d58..8a3dc2cfcd8d3abc50d0dcaf68dd55349860df2b 100644 (file)
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -1886,6 +1886,12 @@ mergetool.writeToTemp::
 mergetool.prompt::
        Prompt before each invocation of the merge resolution program.
 
 mergetool.prompt::
        Prompt before each invocation of the merge resolution program.
 

+notes.mergeStrategy::
+       Which merge strategy to choose by default when resolving notes
+       conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
+       `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
+       section of linkgit:git-notes[1] for more information on each strategy.
+

 notes.displayRef::
        The (fully qualified) refname from which to show notes when
        showing commit messages.  The value of this variable can be set
 notes.displayRef::
        The (fully qualified) refname from which to show notes when
        showing commit messages.  The value of this variable can be set

diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 00c84be33ca950012af99d61878919974401c4a0..71453d4a700f97fe144cbb1309efc31b26eb5fad 100644 (file)
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -101,7 +101,7 @@ merge::
        any) into the current notes ref (called "local").
 +
 If conflicts arise and a strategy for automatically resolving
        any) into the current notes ref (called "local").
 +
 If conflicts arise and a strategy for automatically resolving

-conflicting notes (see the -s/--strategy option) is not given,
+conflicting notes (see the "NOTES MERGE STRATEGIES" section) is not given,

 the "manual" resolver is used. This resolver checks out the
 conflicting notes in a special worktree (`.git/NOTES_MERGE_WORKTREE`),
 and instructs the user to manually resolve the conflicts there.
 the "manual" resolver is used. This resolver checks out the
 conflicting notes in a special worktree (`.git/NOTES_MERGE_WORKTREE`),
 and instructs the user to manually resolve the conflicts there.


@@ -183,6 +183,7 @@ OPTIONS
        When merging notes, resolve notes conflicts using the given
        strategy. The following strategies are recognized: "manual"
        (default), "ours", "theirs", "union" and "cat_sort_uniq".
        When merging notes, resolve notes conflicts using the given
        strategy. The following strategies are recognized: "manual"
        (default), "ours", "theirs", "union" and "cat_sort_uniq".

+       This option overrides the "notes.mergeStrategy" configuration setting.

        See the "NOTES MERGE STRATEGIES" section below for more
        information on each notes merge strategy.
 
        See the "NOTES MERGE STRATEGIES" section below for more
        information on each notes merge strategy.
 


@@ -247,6 +248,9 @@ When done, the user can either finalize the merge with
 'git notes merge --commit', or abort the merge with
 'git notes merge --abort'.
 
 'git notes merge --commit', or abort the merge with
 'git notes merge --abort'.
 

+Users may select an automated merge strategy from among the following using
+either -s/--strategy option or configuring notes.mergeStrategy accordingly:
+

 "ours" automatically resolves conflicting notes in favor of the local
 version (i.e. the current notes ref).
 
 "ours" automatically resolves conflicting notes in favor of the local
 version (i.e. the current notes ref).
 


@@ -310,6 +314,14 @@ core.notesRef::
        This setting can be overridden through the environment and
        command line.
 
        This setting can be overridden through the environment and
        command line.
 

+notes.mergeStrategy::
+       Which merge strategy to choose by default when resolving notes
+       conflicts.  Must be one of `manual`, `ours`, `theirs`, `union`, or
+       `cat_sort_uniq`.  Defaults to `manual`.  See "NOTES MERGE STRATEGIES"
+       section above for more information on each strategy.
++
+This setting can be overridden by passing the `--strategy` option.
+

 notes.displayRef::
        Which ref (or refs, if a glob or specified more than once), in
        addition to the default set by `core.notesRef` or
 notes.displayRef::
        Which ref (or refs, if a glob or specified more than once), in
        addition to the default set by `core.notesRef` or

diff --git a/builtin/notes.c b/builtin/notes.c
index 29816f9fbba284bca363b1e0c641399a313374a4..9026d567cd15cd54df2ceb1f0a8ec8719e104f68 100644 (file)
--- a/builtin/notes.c
+++ b/builtin/notes.c
@@ -737,6 +737,19 @@ static int merge_commit(struct notes_merge_options *o)
        return ret;
 }
 
        return ret;
 }
 

+static int git_config_get_notes_strategy(const char *key,
+                                        enum notes_merge_strategy *strategy)
+{
+       const char *value;
+
+       if (git_config_get_string_const(key, &value))
+               return 1;
+       if (parse_notes_merge_strategy(value, strategy))
+               git_die_config(key, "unknown notes merge strategy %s", value);
+
+       return 0;
+}
+

 static int merge(int argc, const char **argv, const char *prefix)
 {
        struct strbuf remote_ref = STRBUF_INIT, msg = STRBUF_INIT;
 static int merge(int argc, const char **argv, const char *prefix)
 {
        struct strbuf remote_ref = STRBUF_INIT, msg = STRBUF_INIT;


@@ -795,15 +808,17 @@ static int merge(int argc, const char **argv, const char *prefix)
        expand_notes_ref(&remote_ref);
        o.remote_ref = remote_ref.buf;
 
        expand_notes_ref(&remote_ref);
        o.remote_ref = remote_ref.buf;
 

+       t = init_notes_check("merge");
+

        if (strategy) {
                if (parse_notes_merge_strategy(strategy, &o.strategy)) {
                        error("Unknown -s/--strategy: %s", strategy);
                        usage_with_options(git_notes_merge_usage, options);
                }
        if (strategy) {
                if (parse_notes_merge_strategy(strategy, &o.strategy)) {
                        error("Unknown -s/--strategy: %s", strategy);
                        usage_with_options(git_notes_merge_usage, options);
                }

+       } else {
+               git_config_get_notes_strategy("notes.mergeStrategy", &o.strategy);

        }
 
        }
 

-       t = init_notes_check("merge");
-

        strbuf_addf(&msg, "notes: Merged notes from %s into %s",
                    remote_ref.buf, default_notes_ref());
        strbuf_add(&(o.commit_msg), msg.buf + 7, msg.len - 7); /* skip "notes: " */
        strbuf_addf(&msg, "notes: Merged notes from %s into %s",
                    remote_ref.buf, default_notes_ref());
        strbuf_add(&(o.commit_msg), msg.buf + 7, msg.len - 7); /* skip "notes: " */

diff --git a/t/t3309-notes-merge-auto-resolve.sh b/t/t3309-notes-merge-auto-resolve.sh
index 461fd84755d7acc0df346903e6ac1a74d4a9e458..1cd047f8d75f788636db638b397d0ba29883a052 100755 (executable)
--- a/t/t3309-notes-merge-auto-resolve.sh
+++ b/t/t3309-notes-merge-auto-resolve.sh
@@ -298,6 +298,13 @@ test_expect_success 'merge z into y with invalid strategy => Fail/No changes' '
        verify_notes y y
 '
 
        verify_notes y y
 '
 

+test_expect_success 'merge z into y with invalid configuration option => Fail/No changes' '
+       git config core.notesRef refs/notes/y &&
+       test_must_fail git -c notes.mergeStrategy="foo" notes merge z &&
+       # Verify no changes (y)
+       verify_notes y y
+'
+

 cat <<EOF | sort >expect_notes_ours
 68b8630d25516028bed862719855b3d6768d7833 $commit_sha15
 5de7ea7ad4f47e7ff91989fb82234634730f75df $commit_sha14
 cat <<EOF | sort >expect_notes_ours
 68b8630d25516028bed862719855b3d6768d7833 $commit_sha15
 5de7ea7ad4f47e7ff91989fb82234634730f75df $commit_sha14


@@ -365,6 +372,17 @@ test_expect_success 'reset to pre-merge state (y)' '
        verify_notes y y
 '
 
        verify_notes y y
 '
 

+test_expect_success 'merge z into y with "ours" configuration option => Non-conflicting 3-way merge' '
+       git -c notes.mergeStrategy="ours" notes merge z &&
+       verify_notes y ours
+'
+
+test_expect_success 'reset to pre-merge state (y)' '
+       git update-ref refs/notes/y refs/notes/y^1 &&
+       # Verify pre-merge state
+       verify_notes y y
+'
+

 cat <<EOF | sort >expect_notes_theirs
 9b4b2c61f0615412da3c10f98ff85b57c04ec765 $commit_sha15
 5de7ea7ad4f47e7ff91989fb82234634730f75df $commit_sha14
 cat <<EOF | sort >expect_notes_theirs
 9b4b2c61f0615412da3c10f98ff85b57c04ec765 $commit_sha15
 5de7ea7ad4f47e7ff91989fb82234634730f75df $commit_sha14


@@ -432,6 +450,17 @@ test_expect_success 'reset to pre-merge state (y)' '
        verify_notes y y
 '
 
        verify_notes y y
 '
 

+test_expect_success 'merge z into y with "theirs" strategy overriding configuration option "ours" => Non-conflicting 3-way merge' '
+       git -c notes.mergeStrategy="ours" notes merge --strategy=theirs z &&
+       verify_notes y theirs
+'
+
+test_expect_success 'reset to pre-merge state (y)' '
+       git update-ref refs/notes/y refs/notes/y^1 &&
+       # Verify pre-merge state
+       verify_notes y y
+'
+

 cat <<EOF | sort >expect_notes_union
 7c4e546efd0fe939f876beb262ece02797880b54 $commit_sha15
 5de7ea7ad4f47e7ff91989fb82234634730f75df $commit_sha14
 cat <<EOF | sort >expect_notes_union
 7c4e546efd0fe939f876beb262ece02797880b54 $commit_sha15
 5de7ea7ad4f47e7ff91989fb82234634730f75df $commit_sha14


@@ -644,4 +673,15 @@ test_expect_success 'merge y into z with "cat_sort_uniq" strategy => Non-conflic
        verify_notes z cat_sort_uniq
 '
 
        verify_notes z cat_sort_uniq
 '
 

+test_expect_success 'reset to pre-merge state (z)' '
+       git update-ref refs/notes/z refs/notes/z^1 &&
+       # Verify pre-merge state
+       verify_notes z z
+'
+
+test_expect_success 'merge y into z with "cat_sort_uniq" strategy configuration option => Non-conflicting 3-way merge' '
+       git -c notes.mergeStrategy="cat_sort_uniq" notes merge y &&
+       verify_notes z cat_sort_uniq
+'
+

 test_done
 test_done