docs: clarify meaning of -M for git-log
authorJeff King <peff@peff.net>
Sat, 8 May 2010 04:44:34 +0000 (00:44 -0400)
committerJunio C Hamano <gitster@pobox.com>
Wed, 19 May 2010 04:32:41 +0000 (21:32 -0700)
As an option to the "diff" family, it is fairly obvious what
"detect renames" means. However, for revision traversal, the
"-M" option is just included in the long list of options,
with no indication that it is about showing renames in diffs
versus following renames. Let's make it more explicit.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/diff-options.txt

index c9c6c2b1cb61caa6db5e029d6bce1c76a6c075a7..3070dddfe2870b235dced1cf53da22d33ca8fb40 100644 (file)
@@ -177,7 +177,14 @@ endif::git-format-patch[]
        Break complete rewrite changes into pairs of delete and create.
 
 -M::
+ifndef::git-log[]
        Detect renames.
+endif::git-log[]
+ifdef::git-log[]
+       If generating diffs, detect and report renames for each commit.
+       For following files across renames while traversing history, see
+       `--follow`.
+endif::git-log[]
 
 -C::
        Detect copies as well as renames.  See also `--find-copies-harder`.