diff-options.txt: document the new "--dirstat" option
authorGerrit Pape <pape@smarden.org>
Mon, 21 Apr 2008 18:15:52 +0000 (18:15 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 22 Apr 2008 05:50:21 +0000 (22:50 -0700)
This commit adds the documentation for the new option added by 7df7c01
(Add "--dirstat" for some directory statistics, 2008-02-12).

Noticed by Clint Adams, reported through
 http://bugs.debian.org/476437

Signed-off-by: Gerrit Pape <pape@smarden.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/diff-options.txt

index 8dc5b001c42376be1b9f814d516ea43f5c711071..01e7a578510f50af7365ec20e96d1538da424faa 100644 (file)
@@ -58,6 +58,14 @@ endif::git-format-patch[]
        number of modified files, as well as number of added and deleted
        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.
+
 --summary::
        Output a condensed summary of extended header information
        such as creations, renames and mode changes.