[PATCH v2 09/12] fmt-merge-msg: mark summary-related option and config variable as deprecated
Signed-off-by: SZEDER Gábor <szeder@ira.uka.de>
---
Documentation/git-fmt-merge-msg.txt | 16 +++++++++++-----
Documentation/merge-config.txt | 4 +++-
builtin-fmt-merge-msg.c | 2 +-
contrib/completion/git-completion.bash | 1 -
t/t6200-fmt-merge-msg.sh | 2 +-
5 files changed, 16 insertions(+), 9 deletions(-)
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index cd441c5..6e23e6c 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -9,8 +9,8 @@ git-fmt-merge-msg - Produce a merge commit message
SYNOPSIS
--------
[verse]
-git-fmt-merge-msg [--[no-]log | --[no-]summary] <$GIT_DIR/FETCH_HEAD
-git-fmt-merge-msg [--[no-]log | --[no-]summary] -F <file>
+git-fmt-merge-msg [--[no-]log] <$GIT_DIR/FETCH_HEAD
+git-fmt-merge-msg [--[no-]log] -F <file>
DESCRIPTION
-----------
@@ -25,16 +25,20 @@ OPTIONS
-------
--log::
---summary::
In addition to branch names, populate the log message with
one-line descriptions from the actual commits that are being
merged.
--no-log::
---no-summary::
Do not list one-line descriptions from the actual commits being
merged.
+--summary::
+ Deprecated equivalent of --log.
+
+--no-summary::
+ Deprecated equivalent of --no-log.
+
--file <file>, -F <file>::
Take the list of merged objects from <file> instead of
stdin.
@@ -43,10 +47,12 @@ CONFIGURATION
-------------
merge.log::
-merge.summary::
Whether to include summaries of merged commits in newly
merge commit messages. False by default.
+merge.summary::
+ Deprecated equivalent of merge.log.
+
SEE ALSO
--------
linkgit:git-merge[1]
diff --git a/Documentation/merge-config.txt b/Documentation/merge-config.txt
index 5000162..45b107d 100644
--- a/Documentation/merge-config.txt
+++ b/Documentation/merge-config.txt
@@ -6,10 +6,12 @@ merge.diffstat::
Deprecated equivalent of merge.stat.
merge.log::
-merge.summary::
Whether to include summaries of merged commits in newly created
merge commit messages. False by default.
+merge.summary::
+ Deprecated equivalent of merge.log.
+
merge.tool::
Controls which merge resolution program is used by
linkgit:git-mergetool[1]. Valid built-in values are: "kdiff3",
diff --git a/builtin-fmt-merge-msg.c b/builtin-fmt-merge-msg.c
index 3df8ff8..d49f545 100644
--- a/builtin-fmt-merge-msg.c
+++ b/builtin-fmt-merge-msg.c
@@ -6,7 +6,7 @@
#include "tag.h"
static const char *fmt_merge_msg_usage =
- "git-fmt-merge-msg [--log | --summary] [--no-log | --no-summary] [--file <file>]";
+ "git-fmt-merge-msg [--log] [--no-log] [--file <file>]";
static int merge_summary;
diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash
index adc1a75..49ada35 100755
--- a/contrib/completion/git-completion.bash
+++ b/contrib/completion/git-completion.bash
@@ -1025,7 +1025,6 @@ _git_config ()
merge.tool
merge.stat
merge.log
- merge.summary
merge.verbosity
pack.window
pack.depth
diff --git a/t/t6200-fmt-merge-msg.sh b/t/t6200-fmt-merge-msg.sh
index 20704eb..926ca50 100755
--- a/t/t6200-fmt-merge-msg.sh
+++ b/t/t6200-fmt-merge-msg.sh
@@ -177,7 +177,7 @@ test_expect_success 'merge-msg command line options #2' '
git diff actual msg.left.log
'
-test_expect_success 'merge-msg command line options #3' '
+test_expect_success 'merge-msg deprecated command line options' '
git fmt-merge-msg --summary <.git/FETCH_HEAD >actual &&
git diff actual msg.left.log
'
--
1.5.5.76.g546c