X-Git-Url: http://nitlanguage.org diff --git a/share/man/nitmetrics.md b/share/man/nitmetrics.md index 5aeb779..dcdb67c 100644 --- a/share/man/nitmetrics.md +++ b/share/man/nitmetrics.md @@ -2,67 +2,15 @@ # NAME -Computes various metrics on Nit programs. +nitmetrics -- computes various metrics on Nit programs. -# SYNOPSYS +# SYNOPSIS -nitmetrics [*options*]... +nitmetrics [*options*]... FILE... # OPTIONS -`-W`, `--warn` -: Show more warnings - -`-w`, `--warning` -: Show/hide a specific warning - -`-q`, `--quiet` -: Do not show warnings - -`--stop-on-first-error` -: Stop on first error - -`--no-color` -: Do not use color to display errors and warnings - -`--log` -: Generate various log files - -`--log-dir` -: Directory where to generate log files - -`-h`, `-?`, `--help` -: Show Help (This screen) - -`--version` -: Show version and exit - -`--set-dummy-tool` -: Set toolname and version to DUMMY. Useful for testing - -`-v`, `--verbose` -: Verbose - -`--bash-completion` -: Generate bash_completion file for this program - -`--stub-man` -: Generate a stub manpage in pandoc markdown format - -`--disable-phase` -: DEBUG: Disable a specific phase; use `list` to get the list. - -`-I`, `--path` -: Set include path for loaders (may be used more than once) - -`--only-parse` -: Only proceed to parse step of loaders - -`--only-metamodel` -: Stop after meta-model processing - -`--ignore-visibility` -: Do not check, and produce errors, on visibility issues. +## METRICS `--all` : Compute all metrics @@ -100,20 +48,27 @@ nitmetrics [*options*]... `--rta` : Compute RTA metrics -`--csv` -: Export metrics in CSV format - `--generate_hyperdoc` : Generate Hyperdoc `--poset` : Complete metrics on posets +`--detect-variance-constraints` +: Detects the definition-site variance constraints on formal parameters. + + Infers the possible variance annotations of formal types in Nit programs by identifying the existing constraints on the usage of those formal type. + +## OUTPUT + +`--csv` +: Also export metrics in CSV format. + `-d`, `--dir` -: Directory where some statistics files are generated +: Directory where some statistics files are generated. `--no-colors` -: Disable colors in console outputs +: Disable colors in console outputs. # SEE ALSO