{"thread":{"id":"15306","subject":"[PATCH] Improve documentation for --dirstat diff option","startedAt":"2008-09-01T00:50:28Z","lastAt":"2008-09-01T10:34:01Z","messageCount":4,"participants":["Heikki Orsila","Jakub Narebski","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"89349","messageId":"20080901005028.GA31502@zakalwe.fi","threadId":"15306","inReplyTo":null,"subject":"[PATCH] Improve documentation for --dirstat diff option","fromName":"Heikki Orsila","fromEmail":"heikki.orsila@iki.fi","sentAt":"2008-09-01T00:50:28Z","receivedAt":"2008-09-01T00:50:28Z","isPatch":true,"sender":{"key":"heikki.orsila@iki.fi","avatar":null},"body":"Signed-off-by: Heikki Orsila <heikki.orsila@iki.fi>\n---\n Documentation/diff-options.txt |   11 +++++------\n 1 files changed, 5 insertions(+), 6 deletions(-)\n\ndiff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\nindex 1759386..1fda86c 100644\n--- a/Documentation/diff-options.txt\n+++ b/Documentation/diff-options.txt\n@@ -59,12 +59,11 @@ endif::git-format-patch[]\n \tlines.\n \n --dirstat[=limit]::\n-\tOutput only the sub-directories that are impacted by a diff,\n-\tand to what degree they are impacted.  You can override the\n-\tdefault cut-off in percent (3) by \"--dirstat=limit\".  If you\n-\twant to enable \"cumulative\" directory statistics, you can use\n-\tthe \"--cumulative\" flag, which adds up percentages recursively\n-\teven when they have been already reported for a sub-directory.\n+\tOutput the distribution of relative damage (number of lines added or\n+\tremoved) for each sub-directory. Directories with damage below\n+\ta cut-off percent (3% by default) are not shown. The cut-off percent\n+\tcan be set with \"--dirstat=limit\". Damage for a child directory is not\n+\tcounted for the parent directory, unless \"--cumulative\" is used.\n \n --summary::\n \tOutput a condensed summary of extended header information\n-- \n1.6.0.1\n"},{"id":"89383","messageId":"g9gdev$2un$1@ger.gmane.org","threadId":"15306","inReplyTo":"20080901005028.GA31502@zakalwe.fi","subject":"Re: [PATCH] Improve documentation for --dirstat diff option","fromName":"Jakub Narebski","fromEmail":"jnareb@gmail.com","sentAt":"2008-09-01T09:42:54Z","receivedAt":"2008-09-01T09:42:54Z","isPatch":true,"sender":{"key":"jnareb@gmail.com","avatar":"https://avatars.githubusercontent.com/u/2706?v=4"},"body":"Heikki Orsila wrote:\n\n>  --dirstat[=limit]::\n> -       Output only the sub-directories that are impacted by a diff,\n> -       and to what degree they are impacted.  You can override the\n> -       default cut-off in percent (3) by \"--dirstat=limit\".  If you\n> -       want to enable \"cumulative\" directory statistics, you can use\n> -       the \"--cumulative\" flag, which adds up percentages recursively\n> -       even when they have been already reported for a sub-directory.\n> +       Output the distribution of relative damage (number of lines added or\n> +       removed) for each sub-directory. Directories with damage below\n> +       a cut-off percent (3% by default) are not shown. The cut-off percent\n> +       can be set with \"--dirstat=limit\". Damage for a child directory is not\n> +       counted for the parent directory, unless \"--cumulative\" is used.\n\nI rather prefer \"impact\" to \"damage\". And it should probably be \n\"child directory _shown_\".\n\n-- \nJakub Narebski\nWarsaw, Poland\nShadeHawk on #git\n"},{"id":"89396","messageId":"7vwshww458.fsf@gitster.siamese.dyndns.org","threadId":"15306","inReplyTo":"g9gdev$2un$1@ger.gmane.org","subject":"Re: [PATCH] Improve documentation for --dirstat diff option","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2008-09-01T10:29:23Z","receivedAt":"2008-09-01T10:29:23Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Jakub Narebski <jnareb@gmail.com> writes:\n\n> Heikki Orsila wrote:\n> ...\n>> +       can be set with \"--dirstat=limit\". Damage for a child directory is not\n>> +       counted for the parent directory, unless \"--cumulative\" is used.\n>\n> I rather prefer \"impact\" to \"damage\". And it should probably be \n> \"child directory _shown_\".\n\nThe word \"damage\" did raise my eyebrow as well, even though I knew it came\nfrom the wording of the variable to compute it, and coming from somebody\nlike Linus it somewhat sounds funny ;-) I was going to suggest using a\nmore neutral \"change\" in the end user documentation.\n"},{"id":"89398","messageId":"20080901103401.GC16289@zakalwe.fi","threadId":"15306","inReplyTo":"7vwshww458.fsf@gitster.siamese.dyndns.org","subject":"Re: [PATCH] Improve documentation for --dirstat diff option","fromName":"Heikki Orsila","fromEmail":"shdl@zakalwe.fi","sentAt":"2008-09-01T10:34:01Z","receivedAt":"2008-09-01T10:34:01Z","isPatch":true,"sender":{"key":"shdl@zakalwe.fi","avatar":null},"body":"On Mon, Sep 01, 2008 at 03:29:23AM -0700, Junio C Hamano wrote:\n> The word \"damage\" did raise my eyebrow as well, even though I knew it came\n> from the wording of the variable to compute it, and coming from somebody\n> like Linus it somewhat sounds funny ;-)\n\nI rather liked the term \"damage\", but changed it :) \"Impact\" also has \nthe semantic meaning of high-level consequences, like \"impact\" of a\nscientific publication.\n\n-- \nHeikki Orsila\nheikki.orsila@iki.fi\nhttp://www.iki.fi/shd\n"}]}