test_help_collect_default_stdout.gold.txt 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. Usage: metrixpp.py collect [options] -- [path 1] ... [path N]
  2. Options:
  3. -h, --help show this help message and exit
  4. --db-file=DB_FILE, --dbf=DB_FILE
  5. Primary database file to write (by the collector) and
  6. post-process (by other tools) [default: ./metrixpp.db]
  7. --db-file-prev=DB_FILE_PREV, --dbfp=DB_FILE_PREV
  8. Database file with data collected for the
  9. past/previous revision. If it is set for the collector
  10. tool to perform an incremental/iterative collection,
  11. it may reduce the processing time significantly. Post-
  12. processing tools use it in order to recognise/evaluate
  13. change trends. [default: none].
  14. --non-recursively, --nr
  15. If the option is set (True), sub-directories are not
  16. processed [default: False]
  17. --exclude-files=EXCLUDE_FILES, --ef=EXCLUDE_FILES
  18. Defines the pattern to exclude files from processing
  19. [default: ^[.]]
  20. --std.general.proctime, --sgpt
  21. If the option is set (True), the tool measures
  22. processing time per file [default: False]
  23. --std.general.procerrors, --sgpe
  24. If the option is set (True), the tool counts number of
  25. processing/parsing errors per file [default: False]
  26. --std.general.size, --sgs
  27. If the option is set (True), the tool collects file
  28. size metric (in bytes) [default: False]
  29. --log-level=LOG_LEVEL, --ll=LOG_LEVEL
  30. Defines log level. Possible values are
  31. 'DEBUG','INFO','WARNING' or 'ERROR'. Default value is
  32. inherited from environment variable
  33. 'METRIXPLUSPLUS_LOG_LEVEL' if set. [default: INFO]
  34. --std.code.complexity.cyclomatic, --sccc
  35. Enables collection of cyclomatic complexity metric
  36. (McCabe) [default: False]
  37. --std.code.cpp.files=STD.CODE.CPP.FILES
  38. Enumerates filename extensions to match C/C++ files
  39. [default: *.c,*.h,*.cpp,*.hpp,*.cc,*.hh,*.cxx,*.hxx]
  40. --std.code.cs.files=STD.CODE.CS.FILES
  41. Enumerates filename extensions to match C# files
  42. [default: *.cs]
  43. --std.code.java.files=STD.CODE.JAVA.FILES
  44. Enumerates filename extensions to match Java files
  45. [default: *.java]
  46. --std.code.length.total, --sclent
  47. Enables collection of size metric (in number of
  48. symbols per region) [default: False]
  49. --std.code.lines.code, --sclc
  50. Enables collection of lines of code metric - number of
  51. non-empty lines of code, excluding comments [default:
  52. False]
  53. --std.code.lines.preprocessor, --sclp
  54. Enables collection of lines of preprocessor code
  55. metric - number of non-empty lines of preprocessor
  56. code [default: False]
  57. --std.code.lines.comments, --sclcom
  58. Enables collection of lines of comments metric -
  59. number of non-empty lines of comments [default: False]
  60. --std.code.lines.blank, --sclb
  61. Enables collection of blank lines metric - number of
  62. blank lines, i.e. lines without code or comments
  63. [default: False]
  64. --std.code.lines.total, --sclt
  65. Enables collection of lines of comments metric -
  66. number of non-empty lines of comments [default: False]
  67. --std.suppress, --ss If set (True), suppression markers are collected from
  68. comments in code. Suppressions are used by post-
  69. processing tools, like limit, to remove false-positive
  70. warnings. Suppressions should be in the first comment
  71. block of a region (function/class/interface). Format
  72. of suppressions: 'metrix++: suppress metric-name'. For
  73. example: 'metrix++: suppress
  74. std.code.complexity:cyclomatic'. [default: False]