From: Ramkumar Ramachandra Date: Sat, 21 Aug 2010 09:58:17 GMT Subject: [PATCH v4 3/5] fmt-merge-msg: Update fmt-merge-msg and merge-config documentation Message-ID: <1282384699-16477-4-git-send-email-artagnon@gmail.com> In-Reply-To: <1282384699-16477-1-git-send-email-artagnon@gmail.com> Update the documentation of fmt-merge-msg and merge-config to reflect the fact that `merge.log` can either be a boolean or integer option now, instead of just a boolean. Signed-off-by: Ramkumar Ramachandra Cc: Johannes Sixt viscovery.net> Cc: Jonathan Nieder gmail.com> --- Documentation/git-fmt-merge-msg.txt | 15 +++++++++------ Documentation/merge-config.txt | 8 ++++++-- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt index 302f56b..9499322 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' [-m ] [--log | --no-log] <$GIT_DIR/FETCH_HEAD -'git fmt-merge-msg' [-m ] [--log | --no-log] -F +'git fmt-merge-msg' [-m ] [--[no-]log[=]] < $GIT_DIR/FETCH_HEAD +'git fmt-merge-msg' [-m ] [--[no-]log[=]] -F DESCRIPTION ----------- @@ -24,10 +24,10 @@ automatically invoking 'git merge'. OPTIONS ------- ---log:: +--log[=]:: In addition to branch names, populate the log message with - one-line descriptions from the actual commits that are being - merged. + one-line descriptions from at most actual commits that are + being merged. If omitted, defaults to 20. --no-log:: Do not list one-line descriptions from the actual commits being @@ -53,7 +53,10 @@ CONFIGURATION merge.log:: Whether to include summaries of merged commits in newly - merge commit messages. False by default. + created merge commit messages. Optionally, an integer can be + used to specify how many merged commits to summarize (at + maxmium) in the merge message. Specifying "true" is equivalent + to specifying 20. Defaults to false. merge.summary:: Synonym to `merge.log`; this is deprecated and will be removed in diff --git a/Documentation/merge-config.txt b/Documentation/merge-config.txt index b72f533..f63f7cb 100644 --- a/Documentation/merge-config.txt +++ b/Documentation/merge-config.txt @@ -7,8 +7,12 @@ merge.conflictstyle:: marker and the original text before the `=======` marker. merge.log:: - Whether to include summaries of merged commits in newly created - merge commit messages. False by default. + Whether to include summaries of merged commits in newly + created merge commit messages. Optionally, an integer can be + used to specify how many merged commits to summarize (at + maxmium) in the merge message. Specifying "true" is equivalent + to specifying 20. Defaults to false. See also + linkgit:git-fmt-merge-msg[1]. merge.renameLimit:: The number of files to consider when performing rename detection -- 1.7.2.2.409.gdbb11.dirty