From 67105135cb437994e0ad94e3be0705fb7b79d038 Mon Sep 17 00:00:00 2001 From: Sverre Rabbelier Date: Thu, 31 Jul 2008 06:34:15 +0200 Subject: [PATCH] gitstats: Added some example values to gitstats-bug.txt Also added an explanation of how the *_rating settings are used, and what they should be set to. --- doc/gitstats-bug.txt | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/gitstats-bug.txt b/doc/gitstats-bug.txt index a89fa58..8da4f97 100644 --- a/doc/gitstats-bug.txt +++ b/doc/gitstats-bug.txt @@ -33,12 +33,17 @@ You have to configure a few things to get useful results. Configuration is trivially done with: 'git config GitStats.key value'. It is also possible to override most options on the command-line when running the -metric. +metric. The *_rating settings can be set to any integer, +the relevance is in their value relative to one another. +The value of each *_rating setting should represent how +confident you are that a commit is a bugfix when that +specific metric returns a positive result. The following options are available: * 'GitStats.branch_filter', this defines the regexp that, when matched, indicates that a branch is a maintenance branch. When not set, the branch check will be skipped. +Example value: 'maint' * 'GitStats.branch_filter_rating', the amount by which the 'bugfix rating' should be increased when the above filter @@ -48,6 +53,7 @@ matches on a certain commit. * 'GitStats.diff_filter', this defines the regexp that, when matched, indicates that a commit is a bugfix. +Example value: 'test_expect_failure' * 'GitStats.diff_filter_rating', the amount by which the 'bugfix rating' should be increased when the above filter @@ -55,6 +61,7 @@ matches on a certain commit. * 'GitStats.msg_filter', this defines the regexp that, when matched, indicates that a commit is a bugfix. +Example value: 'fixes' * 'GitStats.msg_filter_rating', the amount by which the 'bugfix rating' should be increased when the above filter @@ -70,6 +77,11 @@ commits, and is enabled for those larger than 1000. * 'GitStats.limit', the amount of commits that should be examined by default by 'stats.py bug -a', this defaults to 10, but can be set to a higher value for small repo's. +Example value: For large repositories large value's might +result in slow execution, the default value is pretty +sane for such cases. Smaller repositories might benefit +from setting it to a high value, or disabling it (by +setting it to 0). * 'GitStats.revert_rating', the amount by which the 'bugfix rating' should be increased when the above filter -- 2.11.4.GIT