Stop ignoring Documentation/README
[gitweb.git] / Documentation / git-whatchanged.txt
index 056a9697c68a7de8655d6b9800e40ce3ffd92c48..399bff3bbcab89be96039c373cf1120dcab0efe1 100644 (file)
@@ -1,15 +1,14 @@
 git-whatchanged(1)
 ==================
-v0.99.4, Aug 2005
 
 NAME
 ----
-git-whatchanged - Show logs with difference each commit introduces.
+git-whatchanged - Show logs with difference each commit introduces
 
 
 SYNOPSIS
 --------
-'git whatchanged' <option>...
+'git-whatchanged' <option>...
 
 DESCRIPTION
 -----------
@@ -28,7 +27,7 @@ OPTIONS
        output format that is useful only to tell the changed
        paths and their nature of changes.
 
---max-count=<n>::
+-<n>::
        Limit output to <n> commits.
 
 <since>..<until>::
@@ -44,6 +43,27 @@ OPTIONS
        <format> can be one of 'raw', 'medium', 'short', 'full',
        and 'oneline'.
 
+-m::
+       By default, differences for merge commits are not shown.
+       With this flag, show differences to that commit from all
+       of its parents.
++
+However, it is not very useful in general, although it
+*is* useful on a file-by-file basis.
+
+Examples
+--------
+git-whatchanged -p v2.6.12.. include/scsi drivers/scsi::
+
+       Show as patches the commits since version 'v2.6.12' that changed
+       any file in the include/scsi or drivers/scsi subdirectories
+
+git-whatchanged --since="2 weeks ago" \-- gitk::
+
+       Show the changes during the last two weeks to the file 'gitk'.
+       The "--" is necessary to avoid confusion with the *branch* named
+       'gitk'
+
 
 Author
 ------