summaryrefslogtreecommitdiff
path: root/Documentation/git-cherry-pick.txt
diff options
context:
space:
mode:
authorStephan Beyer <s-beyer@gmx.net>2008-06-08 03:36:09 +0200
committerJunio C Hamano <gitster@pobox.com>2008-06-08 13:46:38 -0700
commit3240240ff427fa2e26a847c7c9fd89e6a4313daa (patch)
treea1e21579aca42b7e4d8d718050bc522961530cfa /Documentation/git-cherry-pick.txt
parentbc47c29ec18164ba1f05600333457cf6f2432856 (diff)
downloadgit-3240240ff427fa2e26a847c7c9fd89e6a4313daa.tar.gz
Docs: Use "-l::\n--long\n" format in OPTIONS sections
The OPTIONS section of a documentation file contains a list of the options a git command accepts. Currently there are several variants to describe the case that different options (almost) do the same in the OPTIONS section. Some are: -f, --foo:: -f|--foo:: -f | --foo:: But AsciiDoc has the special form: -f:: --foo:: This patch applies this form to the documentation of the whole git suite, and removes useless em-dash prevention, so \--foo becomes --foo. Signed-off-by: Stephan Beyer <s-beyer@gmx.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-cherry-pick.txt')
-rw-r--r--Documentation/git-cherry-pick.txt12
1 files changed, 8 insertions, 4 deletions
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 3762272b88..5ac9cfb0ef 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -22,7 +22,8 @@ OPTIONS
For a more complete list of ways to spell commits, see
"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1].
--e|--edit::
+-e::
+--edit::
With this option, `git-cherry-pick` will let you edit the commit
message prior to committing.
@@ -44,14 +45,16 @@ OPTIONS
described above, and `-r` was to disable it. Now the
default is not to do `-x` so this option is a no-op.
--m parent-number|--mainline parent-number::
+-m parent-number::
+--mainline parent-number::
Usually you cannot cherry-pick a merge because you do not know which
side of the merge should be considered the mainline. This
option specifies the parent number (starting from 1) of
the mainline and allows cherry-pick to replay the change
relative to the specified parent.
--n|--no-commit::
+-n::
+--no-commit::
Usually the command automatically creates a commit with
a commit log message stating which commit was
cherry-picked. This flag applies the change necessary
@@ -64,7 +67,8 @@ OPTIONS
This is useful when cherry-picking more than one commits'
effect to your working tree in a row.
--s|--signoff::
+-s::
+--signoff::
Add Signed-off-by line at the end of the commit message.