Improve documentation for --dirstat diff option
authorHeikki Orsila <heikki.orsila@iki.fi>
Mon, 1 Sep 2008 00:50:28 +0000 (03:50 +0300)
committerJunio C Hamano <gitster@pobox.com>
Tue, 2 Sep 2008 06:48:45 +0000 (23:48 -0700)
Signed-off-by: Heikki Orsila <heikki.orsila@iki.fi>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/diff-options.txt

index cba90fd27c6a1baaca884328e96adc8a6da8fc36..746646bb3d09a16a5880fa6bff286389aae98870 100644 (file)
@@ -59,12 +59,11 @@ endif::git-format-patch[]
        lines.
 
 --dirstat[=limit]::
-       Output only the sub-directories that are impacted by a diff,
-       and to what degree they are impacted.  You can override the
-       default cut-off in percent (3) by "--dirstat=limit".  If you
-       want to enable "cumulative" directory statistics, you can use
-       the "--cumulative" flag, which adds up percentages recursively
-       even when they have been already reported for a sub-directory.
+       Output the distribution of relative amount of changes (number of lines added or
+       removed) for each sub-directory. Directories with changes below
+       a cut-off percent (3% by default) are not shown. The cut-off percent
+       can be set with "--dirstat=limit". Changes in a child directory is not
+       counted for the parent directory, unless "--cumulative" is used.
 
 --summary::
        Output a condensed summary of extended header information