summaryrefslogtreecommitdiff
path: root/Documentation/git-commit.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2014-03-23 15:58:12 -0700
committerJunio C Hamano <gitster@pobox.com>2014-03-24 10:43:34 -0700
commite703d7118c68bb5b1f850dae4060609a88500b18 (patch)
tree930af71c9cd0b2e0efc558bd760d6992e58414b2 /Documentation/git-commit.txt
parentce7f8745aa773dfe2fc0a1b8c327b50c7ce4a31e (diff)
downloadgit-e703d7118c68bb5b1f850dae4060609a88500b18.tar.gz
parse-options: multi-word argh should use dash to separate words
"When you need to use space, use dash" is a strange way to say that you must not use a space. Because it is more common for the command line descriptions to use dashed-multi-words, you do not even want to use spaces in these places. Rephrase the documentation to avoid this strangeness. Fix a few existing multi-word argument help strings, i.e. - GPG key-ids given to -S/--gpg-sign are "key-id"; - Refs used for storing notes are "notes-ref"; and - Expiry timestamps given to --expire are "expiry-date". and update the corresponding documentation pages. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-commit.txt')
-rw-r--r--Documentation/git-commit.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 7c42e9cabc..d58758fe1f 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -13,7 +13,7 @@ SYNOPSIS
[-F <file> | -m <msg>] [--reset-author] [--allow-empty]
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
- [-i | -o] [-S[<keyid>]] [--] [<file>...]
+ [-i | -o] [-S[<key-id>]] [--] [<file>...]
DESCRIPTION
-----------