Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing doc. for incremental on Dialyzer analysis #124

Merged
merged 1 commit into from
Dec 19, 2023
Merged

Add missing doc. for incremental on Dialyzer analysis #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions content/en/docs/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,10 +112,11 @@ Higher order provider for running multiple tasks in a sequence, separated by com

Builds and keeps up-to-date a suitable PLT (Persistent Lookup Table), and uses it to carry out success typing analysis on the current project.

| Option | Type | Description | Default |
| ---------------------- | ------- | ------------------------------- | ------- |
| `--update-plt`, `-u` | boolean | Enable updating the PLT. | true |
| `--succ-typings`, `-s` | boolean | Enable success typing analysis. | true |
| Option | Type | Description | Default |
| ---------------------- | ------- | --------------------------------- | ------- |
| `--incremental`, `-i` | boolean | Enable incremental analysis mode. | false |
| `--update-plt`, `-u` | boolean | Enable updating the PLT. | true |
| `--succ-typings`, `-s` | boolean | Enable success typing analysis. | true |

For instructions on suppressing warnings read the [Requesting or Suppressing Warnings in Source Files](https://erlang.org/doc/man/dialyzer.html) section of the Dialyzer documentation.

Expand All @@ -134,6 +135,7 @@ The following (optional) configurations can be added to a `proplist` of options
| `base_plt_apps` | a list of applications to include in the base PLT file |
| `base_plt_location` | the location of base PLT file, `global` to store in $HOME/.cache/rebar3 (default) or a custom directory |
| `base_plt_prefix` | the prefix to the base PLT file, defaults to "rebar3" |
| `incremental` | incremental analysis mode |

## edoc

Expand Down