Documentation: clarify effects of -- <path> arguments
authorThomas Rast <trast@student.ethz.ch>
Tue, 30 Aug 2011 09:21:07 +0000 (11:21 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 30 Aug 2011 17:05:21 +0000 (10:05 -0700)
'git log -- <path>' does not "show commits that affect the specified
paths" in a literal sense unless --full-history is given (for example,
a file that only existed on a side branch will turn up no commits at
all!).

Reword it to specify the actual intent of the filtering, and point to
the "History Simplification" section.

Signed-off-by: Thomas Rast <trast@student.ethz.ch>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-log.txt

index 59f8be0be372acc26c98d162437702d19fd8ed36..771a3565bd10f956899ba95f6ce794bee5f1dede 100644 (file)
@@ -69,10 +69,13 @@ produced by --stat etc.
        its size is not included.
 
 [\--] <path>...::
-       Show only commits that affect any of the specified paths. To
-       prevent confusion with options and branch names, paths may need
-       to be prefixed with "\-- " to separate them from options or
-       refnames.
+       Show only commits that are enough to explain how the files
+       that match the specified paths came to be.  See "History
+       Simplification" below for details and other simplification
+       modes.
++
+To prevent confusion with options and branch names, paths may need to
+be prefixed with "\-- " to separate them from options or refnames.
 
 include::rev-list-options.txt[]