README

   1 This program is licenced under the GPL.
   2 (C) 2008 - 2010 Wang Chen <ellre923@gmail.com>
   3
   4 ==INSTALL==
   5 make
   6 ./kps CHANGELOG [-a]
   7
   8 ==USAGE==
   9 First, you need to create a proper ChangeLog file by following command:
  10 git log -M --date=short --pretty=format:"Author: %aN <%ae>; Date: %ad" --shortstat --dirstat --no-merges v2.6.m..v2.6.n >CHANGELOG
  11 Because I can only analyze this kind of format :(
  12
  13 1. ./kps changelog -a
  14    Output an ordered list of organizations' contribution.
  15    The people belong to the organization will be outputted too.
  16
  17 2. ./kps changelog -c redhat
  18    Output the detail information about redhat's patch contribution.
  19    The people belong to redhat will also be outputted.
  20
  21 3. ./kps changelog -C 10
  22    Output TOP10 organizations which contributed most amount of patches.
  23
  24 4. ./kps changelog -l 2
  25    Output the longtail of contributors whose patch number are less than 2.
  26
  27 5. ./kps changelog -m wangchen
  28    Output patch informations of the people whose name includes "wangchen".
  29
  30 6. ./kps changelog -M 10
  31    Output TOP10 people who contributed most amount of patches.
  32
  33 7. ./kps changelog [OPTION] -n
  34    Don't merge similar people or organizations.
  35    For example: de.ibm.com and us.ibm.com will be treated as two different
  36    organizations.
  37    For merge info, please refer to conv.h.
  38
  39 8. ./kps changelog -x filename.html
  40    Output all info by -a option to an html file.
  41
  42 9. ./kps changelog -s filename.sql -r releasename
  43    Output all info which is converted to sql format to an sql file.
  44
  45 10. ./kps changelog -N NATION
  46    Output all the person who belong to the NATION.
  47
  48 11. ./kps changelog -O WHAT
  49    Output other kind of statistics, now we support "report", "review", "test"
  50    "ack", "sof".
  51    Note: the changelog should be created like this:
  52          "git log | grep "Reported-by" >/root/tools/ChangeLog-all-report"
  53
  54 12. ./kps changelog -w
  55    Report warning about potential duplicated developers.
  56
  57 13. ./kps changelog -e
  58    Anti Email Spam, this will convert all email addresses to coded text.
  59
  60 14. ./kps changelog -I
  61    Output an ordered list of organizations' contribution.
  62    The area in which the organization is most interesting will be outputted too.
  63
  64 15. ./kps changelog -i
  65    Output an ordered list of nation' contribution.
  66    The area in which the nation is most interesting will be outputted too.
  67
  68
  69
  70 For "changed line" statistic please use option "-L".
  71
  72 For more option, please use "-h".