git blame: document that it always follows origin across whole-file renames
authorJunio C Hamano <gitster@pobox.com>
Fri, 21 Sep 2012 19:09:42 +0000 (12:09 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 21 Sep 2012 19:14:19 +0000 (12:14 -0700)
Make it clear to people who (rightly or wrongly) think that the
"--follow" option should follow origin across while-file renames
that we already do so.  That would explain the output that they see
when they do give the "--follow" option to the command.

We may or may not want to do a "--no-follow" patch as a follow-up,
but that is a separate topic.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-blame.txt

index 7ee923629ecc0dbf12a845f18d02c317b6266066..e44173f66afa9e1e1656e7b388fd707c417a1d28 100644 (file)
@@ -20,6 +20,12 @@ last modified the line. Optionally, start annotating from the given revision.
 
 The command can also limit the range of lines annotated.
 
+The origin of lines is automatically followed across whole-file
+renames (currently there is no option to turn the rename-following
+off). To follow lines moved from one file to another, or to follow
+lines that were copied and pasted from another file, etc., see the
+`-C` and `-M` options.
+
 The report does not tell you anything about lines which have been deleted or
 replaced; you need to use a tool such as 'git diff' or the "pickaxe"
 interface briefly mentioned in the following paragraph.