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>,
Junio C Hamano <gitster@pobox.com>
Subject: [PATCH v4 3/5] fmt-merge-msg: Update fmt-merge-msg and merge-config documentation
Date: Sat, 21 Aug 2010 15:28:17 +0530 [thread overview]
Message-ID: <1282384699-16477-4-git-send-email-artagnon@gmail.com> (raw)
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 <artagnon@gmail.com>
Cc: Johannes Sixt <j.sixt <at> viscovery.net>
Cc: Jonathan Nieder <jrnieder <at> 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 <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>] [--[no-]log[=<n>]] < $GIT_DIR/FETCH_HEAD
+'git fmt-merge-msg' [-m <message>] [--[no-]log[=<n>]] -F <file>
DESCRIPTION
-----------
@@ -24,10 +24,10 @@ 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.
+ one-line descriptions from at most <n> actual commits that are
+ being merged. If omitted, <n> 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
next prev parent reply other threads:[~2010-08-21 10:00 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-08-21 9:58 [PATCH v4 0/5] fmt-merge-msg improvements Ramkumar Ramachandra
2010-08-21 9:58 ` [PATCH v4 1/5] fmt-merge-msg: Make the number of log entries in commit message configurable Ramkumar Ramachandra
2010-08-22 3:33 ` Jonathan Nieder
2010-08-22 5:05 ` Junio C Hamano
2010-08-22 6:53 ` Ramkumar Ramachandra
2010-08-21 9:58 ` [PATCH v4 2/5] fmt-merge-msg: Update command line options to sync with config options Ramkumar Ramachandra
2010-08-21 9:58 ` Ramkumar Ramachandra [this message]
2010-08-21 9:58 ` [PATCH v4 4/5] fmt-merge-msg: Remove deprecated --summary option Ramkumar Ramachandra
2010-08-21 9:58 ` [PATCH v4 5/5] parse-options: clarify PARSE_OPT_NOARG description Ramkumar Ramachandra
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1282384699-16477-4-git-send-email-artagnon@gmail.com \
--to=artagnon@gmail.com \
--cc=debian@onerussian.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=j.sixt@viscovery.net \
--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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).