* [PATCH] Improve documentation for --dirstat diff option
@ 2008-09-01 10:13 Heikki Orsila
2008-09-01 10:18 ` Abhijit Menon-Sen
0 siblings, 1 reply; 6+ messages in thread
From: Heikki Orsila @ 2008-09-01 10:13 UTC (permalink / raw)
To: git; +Cc: Junio C Hamano
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
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH] Improve documentation for --dirstat diff option
@ 2008-09-01 0:50 Heikki Orsila
2008-09-01 9:42 ` Jakub Narebski
0 siblings, 1 reply; 6+ messages in thread
From: Heikki Orsila @ 2008-09-01 0:50 UTC (permalink / raw)
To: git; +Cc: Junio C Hamano
Signed-off-by: Heikki Orsila <heikki.orsila@iki.fi>
---
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..1fda86c 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 damage (number of lines added or
+ removed) for each sub-directory. Directories with damage below
+ a cut-off percent (3% by default) are not shown. The cut-off percent
+ can be set with "--dirstat=limit". Damage for a child directory is not
+ counted for the parent directory, unless "--cumulative" is used.
--summary::
Output a condensed summary of extended header information
--
1.6.0.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] Improve documentation for --dirstat diff option
2008-09-01 0:50 Heikki Orsila
@ 2008-09-01 9:42 ` Jakub Narebski
2008-09-01 10:29 ` Junio C Hamano
0 siblings, 1 reply; 6+ messages in thread
From: Jakub Narebski @ 2008-09-01 9:42 UTC (permalink / raw)
To: git
Heikki Orsila wrote:
> --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 damage (number of lines added or
> + removed) for each sub-directory. Directories with damage below
> + a cut-off percent (3% by default) are not shown. The cut-off percent
> + can be set with "--dirstat=limit". Damage for a child directory is not
> + counted for the parent directory, unless "--cumulative" is used.
I rather prefer "impact" to "damage". And it should probably be
"child directory _shown_".
--
Jakub Narebski
Warsaw, Poland
ShadeHawk on #git
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Improve documentation for --dirstat diff option
2008-09-01 9:42 ` Jakub Narebski
@ 2008-09-01 10:29 ` Junio C Hamano
2008-09-01 10:34 ` Heikki Orsila
0 siblings, 1 reply; 6+ messages in thread
From: Junio C Hamano @ 2008-09-01 10:29 UTC (permalink / raw)
To: Jakub Narebski; +Cc: git
Jakub Narebski <jnareb@gmail.com> writes:
> Heikki Orsila wrote:
> ...
>> + can be set with "--dirstat=limit". Damage for a child directory is not
>> + counted for the parent directory, unless "--cumulative" is used.
>
> I rather prefer "impact" to "damage". And it should probably be
> "child directory _shown_".
The word "damage" did raise my eyebrow as well, even though I knew it came
from the wording of the variable to compute it, and coming from somebody
like Linus it somewhat sounds funny ;-) I was going to suggest using a
more neutral "change" in the end user documentation.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Improve documentation for --dirstat diff option
2008-09-01 10:29 ` Junio C Hamano
@ 2008-09-01 10:34 ` Heikki Orsila
0 siblings, 0 replies; 6+ messages in thread
From: Heikki Orsila @ 2008-09-01 10:34 UTC (permalink / raw)
To: Junio C Hamano; +Cc: Jakub Narebski, git
On Mon, Sep 01, 2008 at 03:29:23AM -0700, Junio C Hamano wrote:
> The word "damage" did raise my eyebrow as well, even though I knew it came
> from the wording of the variable to compute it, and coming from somebody
> like Linus it somewhat sounds funny ;-)
I rather liked the term "damage", but changed it :) "Impact" also has
the semantic meaning of high-level consequences, like "impact" of a
scientific publication.
--
Heikki Orsila
heikki.orsila@iki.fi
http://www.iki.fi/shd
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2008-09-01 10:35 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-09-01 10:13 [PATCH] Improve documentation for --dirstat diff option Heikki Orsila
2008-09-01 10:18 ` 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
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).