git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Heikki Orsila <heikki.orsila@iki.fi>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH] Improve documentation for --dirstat diff option
Date: Mon, 1 Sep 2008 13:13:34 +0300	[thread overview]
Message-ID: <20080901101334.GA4544@zakalwe.fi> (raw)

Signed-off-by: Heikki Orsila <heikki.orsila@iki.fi>
---
My earlier version of the patch already gave an example of use. This 
version changes the word "damage" to "impact" (Jakub Narebski's 
suggestion).

 Documentation/diff-options.txt |   11 +++++------
 1 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 1759386..150debb 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -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 impact (number of lines added or
+	removed) for each sub-directory. Directories with impact below
+	a cut-off percent (3% by default) are not shown. The cut-off percent
+	can be set with "--dirstat=limit". Child directory impact is not
+	counted for the parent directory, unless "--cumulative" is used.
 
 --summary::
 	Output a condensed summary of extended header information
-- 
1.6.0.1

             reply	other threads:[~2008-09-01 10:14 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-09-01 10:13 Heikki Orsila [this message]
2008-09-01 10:18 ` [PATCH] Improve documentation for --dirstat diff option Abhijit Menon-Sen
  -- strict thread matches above, loose matches on Subject: below --
2008-09-01  0:50 Heikki Orsila
2008-09-01  9:42 ` Jakub Narebski
2008-09-01 10:29   ` Junio C Hamano
2008-09-01 10:34     ` Heikki Orsila

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20080901101334.GA4544@zakalwe.fi \
    --to=heikki.orsila@iki.fi \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).