test_help_collect_default_stdout.gold.txt 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. Usage: python metrix++.py --help
  2. python metrix++.py collect --help
  3. python metrix++.py collect [options] -- [path 1] ... [path N]
  4. Options:
  5. -h, --help show this help message and exit
  6. --db-file=DB_FILE, --dbf=DB_FILE
  7. Path to a database file to create and write [default:
  8. ./metrixpp.db].
  9. --db-file-prev=DB_FILE_PREV, --dbfp=DB_FILE_PREV
  10. Path to database file with data collected for the
  11. past/previous code revision. If it is set, the tool
  12. will do an incremental/iterative collection. It may
  13. reduce the time of processing significantly [default:
  14. none].
  15. --log-level=LOG_LEVEL, --ll=LOG_LEVEL
  16. Defines log level. Possible values are
  17. 'DEBUG','INFO','WARNING' or 'ERROR'. Default value is
  18. inherited from environment variable
  19. 'METRIXPLUSPLUS_LOG_LEVEL' if set. [default: INFO]
  20. --std.code.complexity.cyclomatic, --sccc
  21. Enables collection of cyclomatic complexity metric
  22. (McCabe) [default: False]
  23. --std.code.complexity.maxindent, --sccmi
  24. Enables collection of maximum indent level metric
  25. [default: False]
  26. --std.code.cpp.files=STD.CODE.CPP.FILES
  27. Enumerates filename extensions to match C/C++ files
  28. [default: *.c,*.h,*.cpp,*.hpp,*.cc,*.hh,*.cxx,*.hxx]
  29. --std.code.cs.files=STD.CODE.CS.FILES
  30. Enumerates filename extensions to match C# files
  31. [default: *.cs]
  32. --std.code.java.files=STD.CODE.JAVA.FILES
  33. Enumerates filename extensions to match Java files
  34. [default: *.java]
  35. --std.code.length.total, --sclent
  36. Enables collection of size metric (in number of
  37. symbols per region) [default: False]
  38. --std.code.lines.code, --sclc
  39. Enables collection of lines of code metric - number of
  40. non-empty lines of code, excluding comments [default:
  41. False]
  42. --std.code.lines.preprocessor, --sclp
  43. Enables collection of lines of preprocessor code
  44. metric - number of non-empty lines of preprocessor
  45. code [default: False]
  46. --std.code.lines.comments, --sclcom
  47. Enables collection of lines of comments metric -
  48. number of non-empty lines of comments [default: False]
  49. --std.code.lines.total, --sclt
  50. Enables collection of lines of comments metric -
  51. number of non-empty lines of comments [default: False]
  52. --std.code.magic.numbers, --scmn
  53. Enables collection of magic numbers metric [default:
  54. False]
  55. --std.code.magic.numbers.simplier, --scmns
  56. Is set, 0, -1 and 1 numbers are not counted in
  57. 'std.code.magic.numbers' metric [default: False]
  58. --std.code.mi.simple, --scms
  59. Enables collection of simple maintainability index
  60. metric. It uses std.code.line:code,
  61. std.code.complexity:cyclomatic metrics to rank level
  62. of maintainability. Lower value of this metric
  63. indicates better maintainability. [default: False]
  64. --std.code.todo.comments, --sctc
  65. Enables collection of number of todo/fixme/etc markers
  66. in comments [default: False]
  67. --std.code.todo.strings, --scts
  68. Enables collection of number of todo/fixme/etc markers
  69. in strings [default: False]
  70. --std.code.todo.tags=STD.CODE.TODO.TAGS, --sctt=STD.CODE.TODO.TAGS
  71. A list of typical todo markers to search, separated by
  72. comma [default: TODO,ToDo,FIXME,FixMe,TBD,HACK,XXX]
  73. --std.suppress, --ss If set (True), suppression markers are collected from
  74. comments in code. Suppressions are used by post-
  75. processing tools, like limit, to remove false-positive
  76. warnings. Suppressions should be in the first comment
  77. block of a region (function/class/interface). Format
  78. of suppressions: 'metrix++: suppress metric-name'. For
  79. example: 'metrix++: suppress
  80. std.code.complexity:cyclomatic'. [default: False]
  81. --std.general.proctime, --sgpt
  82. If the option is set (True), the tool measures
  83. processing time per file [default: False]
  84. --std.general.procerrors, --sgpe
  85. If the option is set (True), the tool counts number of
  86. processing/parsing errors per file [default: False]
  87. --std.general.size, --sgs
  88. If the option is set (True), the tool collects file
  89. size metric (in bytes) [default: False]
  90. --exclude-files=EXCLUDE_FILES, --ef=EXCLUDE_FILES
  91. Defines the pattern to exclude files from processing
  92. [default: ^[.]]
  93. --non-recursively, --nr
  94. If the option is set (True), sub-directories are not
  95. processed [default: False]