Documentation: use brackets for optional arguments
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>
brian m. carlson committed
Feb 22, 2017 at 12:25 UTC
2b35a9f4c7bd60b26fbadab7343a7f29f1cbe964
1 file changed
+2
-2
Documentation/blame-options.txt
+2
-2
@@ -76,7 +76,7 @@ include::line-range-format.txt[]
76
terminal. Can't use `--progress` together with `--porcelain`
77
or `--incremental`.
78
79
--M|<num>|::
79
+-M[<num>]::
80
Detect moved or copied lines within a file. When a commit
81
moves or copies a block of lines (e.g. the original file
82
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
92
within a file for it to associate those lines with the parent
93
commit. The default value is 20.
94
95
--C|<num>|::
95
+-C[<num>]::
96
In addition to `-M`, detect lines moved or copied from other
97
files that were modified in the same commit. This is
98
useful when you reorganize your program and move code