# [PATCH] Improve documentation for --dirstat diff option 4 messages from 2008-09-01 to 2008-09-01. Participants: Heikki Orsila, Jakub Narebski, Junio C Hamano. Thread: https://gitlist.dev/t/15306 ## Heikki Orsila, 2008-09-01 00:50 Subject: [PATCH] Improve documentation for --dirstat diff option Message-ID: <20080901005028.GA31502@zakalwe.fi> URL: https://gitlist.dev/e/20080901005028.GA31502%40zakalwe.fi ``` Signed-off-by: Heikki Orsila --- 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 ``` ## Jakub Narebski, 2008-09-01 09:42 Subject: Re: [PATCH] Improve documentation for --dirstat diff option Message-ID: URL: https://gitlist.dev/e/g9gdev%242un%241%40ger.gmane.org In-Reply-To: <20080901005028.GA31502@zakalwe.fi> ``` 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 ``` ## Junio C Hamano, 2008-09-01 10:29 Subject: Re: [PATCH] Improve documentation for --dirstat diff option Message-ID: <7vwshww458.fsf@gitster.siamese.dyndns.org> URL: https://gitlist.dev/e/7vwshww458.fsf%40gitster.siamese.dyndns.org In-Reply-To: ``` Jakub Narebski 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. ``` ## Heikki Orsila, 2008-09-01 10:34 Subject: Re: [PATCH] Improve documentation for --dirstat diff option Message-ID: <20080901103401.GC16289@zakalwe.fi> URL: https://gitlist.dev/e/20080901103401.GC16289%40zakalwe.fi In-Reply-To: <7vwshww458.fsf@gitster.siamese.dyndns.org> ``` 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 ```