summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2017-02-22 12:25:46 +0000
committerJunio C Hamano <gitster@pobox.com>2017-02-22 10:22:15 -0800
commit2b35a9f4c7bd60b26fbadab7343a7f29f1cbe964 (patch)
tree4c9918e3e4b4a729475e66d40fc3ad7e5eaff7a4
parent0b65a8dbdb38962e700ee16776a3042beb489060 (diff)
downloadgit-bc/blame-doc-fix.tar.gz
Documentation: use brackets for optional argumentsbc/blame-doc-fix
The documentation for git blame used vertical bars for optional arguments to -M and -C, which is unusual and potentially confusing. Since most man pages use brackets for optional items, and that's consistent with how we document the same options for git diff and friends, use brackets here, too. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/blame-options.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
index 02cb6845cd..c233a72f79 100644
--- a/Documentation/blame-options.txt
+++ b/Documentation/blame-options.txt
@@ -76,7 +76,7 @@ include::line-range-format.txt[]
terminal. Can't use `--progress` together with `--porcelain`
or `--incremental`.
--M|<num>|::
+-M[<num>]::
Detect moved or copied lines within a file. When a commit
moves or copies a block of lines (e.g. the original file
has A and then B, and the commit changes it to B and then
@@ -92,7 +92,7 @@ alphanumeric characters that Git must detect as moving/copying
within a file for it to associate those lines with the parent
commit. The default value is 20.
--C|<num>|::
+-C[<num>]::
In addition to `-M`, detect lines moved or copied from other
files that were modified in the same commit. This is
useful when you reorganize your program and move code