test_help_collect_default_stdout.gold.txt 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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.suppress, --ss If set (True), suppression markers are collected from
  53. comments in code. Suppressions are used by post-
  54. processing tools, like limit, to remove false-positive
  55. warnings. Suppressions should be in the first comment
  56. block of a region (function/class/interface). Format
  57. of suppressions: 'metrix++: suppress metric-name'. For
  58. example: 'metrix++: suppress
  59. std.code.complexity:cyclomatic'. [default: False]
  60. --std.general.proctime, --sgpt
  61. If the option is set (True), the tool measures
  62. processing time per file [default: False]
  63. --std.general.procerrors, --sgpe
  64. If the option is set (True), the tool counts number of
  65. processing/parsing errors per file [default: False]
  66. --std.general.size, --sgs
  67. If the option is set (True), the tool collects file
  68. size metric (in bytes) [default: False]
  69. --exclude-files=EXCLUDE_FILES, --ef=EXCLUDE_FILES
  70. Defines the pattern to exclude files from processing
  71. [default: ^[.]]
  72. --non-recursively, --nr
  73. If the option is set (True), sub-directories are not
  74. processed [default: False]