git blame: document that it always follows origin across whole-file renames
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>
Junio C Hamano committed
Sep 21, 2012 at 12:09 UTC
e5dce96e9e26f8e30291c79fa5647313c64b2150
1 file changed
+6
Documentation/git-blame.txt
+6
@@ -20,6 +20,12 @@ last modified the line. Optionally, start annotating from the given revision.
20
21
The command can also limit the range of lines annotated.
22
23
+The origin of lines is automatically followed across whole-file
24
+renames (currently there is no option to turn the rename-following
25
+off). To follow lines moved from one file to another, or to follow
26
+lines that were copied and pasted from another file, etc., see the
27
+`-C` and `-M` options.
28
+
29
The report does not tell you anything about lines which have been deleted or
30
replaced; you need to use a tool such as 'git diff' or the "pickaxe"
31
interface briefly mentioned in the following paragraph.