From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: Johannes Sixt <j.sixt@viscovery.net>,
Jonathan Nieder <jrnieder@gmail.com>,
Yaroslav Halchenko <debian@onerussian.com>,
Jakub Narebski <jnareb@gmail.com>
Subject: [PATCH v3 5/5] fmt-merge-msg: Update fmt-merge-msg and merge-config documentation
Date: Sat, 21 Aug 2010 00:45:02 +0530 [thread overview]
Message-ID: <1282331702-5115-6-git-send-email-artagnon@gmail.com> (raw)
In-Reply-To: <1282331702-5115-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 <artagnon@gmail.com>
---
Documentation/git-fmt-merge-msg.txt | 20 +++++++++-----------
Documentation/merge-config.txt | 8 ++++++--
2 files changed, 15 insertions(+), 13 deletions(-)
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 78c8a6d..4149a1f 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 <message>] [--log | --no-log] <$GIT_DIR/FETCH_HEAD
-'git fmt-merge-msg' [-m <message>] [--log | --no-log] -F <file>
+'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] < $GIT_DIR/FETCH_HEAD
+'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] -F <file>
DESCRIPTION
-----------
@@ -24,19 +24,14 @@ automatically invoking 'git merge'.
OPTIONS
-------
---log::
+--log=<n>::
In addition to branch names, populate the log message with
- one-line descriptions from the actual commits that are being
- merged.
-
--no-log::
Do not list one-line descriptions from the actual commits being
merged.
---summary::
---no-summary::
- Synonyms to --log and --no-log; these are deprecated and will be
- removed in the future.
+ one-line descriptions from at most <n> actual commits that are
+ being merged.
-m <message>::
--message <message>::
@@ -53,7 +48,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.
SEE ALSO
--------
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
prev parent reply other threads:[~2010-08-20 19:18 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-20 19:14 [PATCH v3 0/5] fmt-merge-msg improvements Ramkumar Ramachandra
2010-08-20 19:14 ` [PATCH v3 1/5] parse-options: Allow PARSE_OPT_NOARG in integer arguments Ramkumar Ramachandra
2010-08-20 19:49 ` Junio C Hamano
2010-08-20 20:01 ` Ramkumar Ramachandra
2010-08-21 3:39 ` Jonathan Nieder
2010-08-20 19:14 ` [PATCH v3 2/5] fmt-merge-msg: Make the number of log entries in commit message configurable Ramkumar Ramachandra
2010-08-21 3:54 ` Jonathan Nieder
2010-08-21 5:55 ` Ramkumar Ramachandra
2010-08-20 19:15 ` [PATCH v3 3/5] fmt-merge-msg: Update command line options to sync with config options Ramkumar Ramachandra
2010-08-21 4:02 ` Jonathan Nieder
2010-08-21 5:51 ` Ramkumar Ramachandra
2010-08-20 19:15 ` [PATCH v3 4/5] fmt-merge-msg: Remove deprecated --summary option Ramkumar Ramachandra
2010-08-21 4:04 ` Jonathan Nieder
2010-08-21 5:49 ` Ramkumar Ramachandra
2010-08-20 19:15 ` Ramkumar Ramachandra [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1282331702-5115-6-git-send-email-artagnon@gmail.com \
--to=artagnon@gmail.com \
--cc=debian@onerussian.com \
--cc=git@vger.kernel.org \
--cc=j.sixt@viscovery.net \
--cc=jnareb@gmail.com \
--cc=jrnieder@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.