mirror of
https://github.com/git/git
synced 2024-07-17 02:57:48 +00:00
33e8fc8740
The synopsys text and the usage string of subcommands that read list of things from the standard input are often shown like this: git gostak [--distim] < <list-of-doshes> This is problematic in a number of ways: * The way to use these commands is more often to feed them the output from another command, not feed them from a file. * Manual pages outside Git, commands that operate on the data read from the standard input, e.g "sort", "grep", "sed", etc., are not described with such a "< redirection-from-file" in their synopsys text. Our doing so introduces inconsistency. * We do not insist on where the output should go, by saying git gostak [--distim] < <list-of-doshes> > <output> * As it is our convention to enclose placeholders inside <braket>, the redirection operator followed by a placeholder filename becomes very hard to read, both in the documentation and in the help text. Let's clean them all up, after making sure that the documentation clearly describes the modes that take information from the standard input and what kind of things are expected on the input. [jc: stole example for fmt-merge-msg from Jonathan] Helped-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
79 lines
1.7 KiB
Plaintext
79 lines
1.7 KiB
Plaintext
git-fmt-merge-msg(1)
|
|
====================
|
|
|
|
NAME
|
|
----
|
|
git-fmt-merge-msg - Produce a merge commit message
|
|
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log]
|
|
'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] -F <file>
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
Takes the list of merged objects on stdin and produces a suitable
|
|
commit message to be used for the merge commit, usually to be
|
|
passed as the '<merge-message>' argument of 'git merge'.
|
|
|
|
This command is intended mostly for internal use by scripts
|
|
automatically invoking 'git merge'.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
--log[=<n>]::
|
|
In addition to branch names, populate the log message with
|
|
one-line descriptions from the actual commits that are being
|
|
merged. At most <n> commits from each merge parent will be
|
|
used (20 if <n> is omitted). This overrides the `merge.log`
|
|
configuration variable.
|
|
|
|
--no-log::
|
|
Do not list one-line descriptions from the actual commits being
|
|
merged.
|
|
|
|
--[no-]summary::
|
|
Synonyms to --log and --no-log; these are deprecated and will be
|
|
removed in the future.
|
|
|
|
-m <message>::
|
|
--message <message>::
|
|
Use <message> instead of the branch names for the first line
|
|
of the log message. For use with `--log`.
|
|
|
|
-F <file>::
|
|
--file <file>::
|
|
Take the list of merged objects from <file> instead of
|
|
stdin.
|
|
|
|
CONFIGURATION
|
|
-------------
|
|
include::fmt-merge-msg-config.txt[]
|
|
|
|
merge.summary::
|
|
Synonym to `merge.log`; this is deprecated and will be removed in
|
|
the future.
|
|
|
|
EXAMPLE
|
|
-------
|
|
|
|
--
|
|
$ git fetch origin master
|
|
$ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
|
|
--
|
|
|
|
Print a log message describing a merge of the "master" branch from
|
|
the "origin" remote.
|
|
|
|
|
|
SEE ALSO
|
|
--------
|
|
linkgit:git-merge[1]
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|