Merge: doc: fixed some typos and other misc. corrections

[nit.git] / share / man / nitmetrics.md

diff --git a/share/man/nitmetrics.md b/share/man/nitmetrics.md
index 5aeb779..9d7dfc6 100644 (file)
--- a/share/man/nitmetrics.md
+++ b/share/man/nitmetrics.md
@@ -1,119 +1,75 @@
-% NITMETRICS(1)
-
 # 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.
+## METRICS
 
-`-I`, `--path`
-:   Set include path for loaders (may be used more than once)
+### `--all`
+Compute all metrics.
 
-`--only-parse`
-:   Only proceed to parse step of loaders
+### `--mmodules`
+Compute metrics about mmodules.
 
-`--only-metamodel`
-:   Stop after meta-model processing
+### `--mclasses`
+Compute metrics about mclasses.
 
-`--ignore-visibility`
-:   Do not check, and produce errors, on visibility issues.
+### `--mendel`
+Compute mendel metrics.
 
-`--all`
-:   Compute all metrics
+### `--inheritance`
+Compute metrics about inheritance usage.
 
-`--mmodules`
-:   Compute metrics about mmodules
+### `--refinement`
+Compute metrics about refinement usage.
 
-`--mclasses`
-:   Compute metrics about mclasses
+### `--self`
+Compute metrics about the usage of explicit and implicit self.
 
-`--mendel`
-:   Compute mendel metrics
+### `--ast`
+Compute metrics about the usage of nodes and identifiers in the AST.
 
-`--inheritance`
-:   Compute metrics about inheritance usage
+### `--nullables`
+Compute metrics on nullables send.
 
-`--refinement`
-:   Compute metrics about refinement usage
+### `--static-types`
+Compute explicit static types metrics.
 
-`--self`
-:   Compute metrics about the usage of explicit and implicit self
+### `--tables`
+Compute tables metrics.
 
-`--ast`
-:   Compute metrics about the usage of nodes and identifiers in the AST
+### `--rta`
+Compute RTA metrics.
 
-`--nullables`
-:   Compute metrics on nullables send
+### `--generate_hyperdoc`
+Generate Hyperdoc.
 
-`--static-types`
-:   Compute explicit static types metrics
+### `--poset`
+Complete metrics on posets.
 
-`--tables`
-:   Compute tables metrics
+### `--detect-variance-constraints`
+Detect the definition-site variance constraints on formal parameters.
 
-`--rta`
-:   Compute RTA metrics
+Infers the possible variance annotations of formal types in Nit programs by identifying the existing constraints on the usage of those formal type.
 
-`--csv`
-:   Export metrics in CSV format
+### `--detect-covariance`
+Detect the static covariance usages.
 
-`--generate_hyperdoc`
-:   Generate Hyperdoc
+## OUTPUT
 
-`--poset`
-:   Complete metrics on posets
+### `--csv`
+Also export metrics in CSV format.
 
-`-d`, `--dir`
-:   Directory where some statistics files are generated
+### `-d`, `--dir`
+Directory where some statistics files are generated.
 
-`--no-colors`
-:   Disable colors in console outputs
+### `--no-colors`
+Disable colors in console outputs.
 
 # SEE ALSO