Skip to content

Commit b0201d1

Browse files
committed
Improve documentation of the ignore file
Rewrite passages on `--format dialyzer` and `--format short` Remove mention of `--format ignore_file`
1 parent a03b926 commit b0201d1

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,12 @@ mix dialyzer
5151

5252
* `--no-compile` - do not compile even if needed.
5353
* `--no-check` - do not perform (quick) check to see if PLT needs to be updated.
54-
* `--ignore-exit-status` - display warnings but do not halt the VM or return an exit status code
55-
* `--format short` - format the warnings in a compact format.
56-
* `--format raw` - format the warnings in format returned before Dialyzer formatting
57-
* `--format dialyxir` - format the warnings in a pretty printed format
58-
* `--format dialyzer` - format the warnings in the original Dialyzer format
59-
* `--format ignore_file` - format the warnings to be suitable for adding to "Elixir Term Format" ignore file
60-
* `--quiet` - suppress all informational messages
54+
* `--ignore-exit-status` - display warnings but do not halt the VM or return an exit status code.
55+
* `--format short` - format the warnings in a compact format, suitable for ignore file using Elixir term format.
56+
* `--format raw` - format the warnings in format returned before Dialyzer formatting.
57+
* `--format dialyxir` - format the warnings in a pretty printed format.
58+
* `--format dialyzer` - format the warnings in the original Dialyzer format, suitable for ignore file using simple string matches.
59+
* `--quiet` - suppress all informational messages.
6160

6261
Warning flags passed to this task are passed on to `:dialyzer` - e.g.
6362

@@ -292,6 +291,8 @@ end
292291

293292
This file comes in two formats: `--format dialyzer` string matches (compatible with `<= 0.5.1` ignore files), and the [term format](#elixir-term-format).
294293

294+
Dialyzer will look for an ignore file using the term format with the name `.dialyzer_ignore.exs` by default if you don't specify something otherwise.
295+
295296
#### Simple String Matches
296297

297298
Any line of dialyzer format output (partially) matching a line in `"dialyzer.ignore-warnings"` is filtered.
@@ -327,8 +328,8 @@ done (warnings were emitted)
327328

328329
#### Elixir Term Format
329330

330-
Dialyxir also recognizes an Elixir format of the ignore file. If your ignore file is an `exs` file, Dialyxir will evaluate it and process its data structure. Entries for existing warnings can be generated with `mix dialyzer --format ignore_file`. Lines may be either tuples or an arbitrary Regex
331-
applied to the *short-description* (`mix dialyzer --format short`). The file looks like the following:
331+
Dialyxir also recognizes an Elixir format of the ignore file. If your ignore file is an `exs` file, Dialyxir will evaluate it and process its data structure. A line may be either a tuple or an arbitrary Regex
332+
applied to the *short-description* format of Dialyzer output (`mix dialyzer --format short`). The file looks like the following:
332333

333334
```elixir
334335
# .dialyzer_ignore.exs
@@ -350,6 +351,9 @@ applied to the *short-description* (`mix dialyzer --format short`). The file loo
350351
]
351352
```
352353

354+
Entries for existing warnings can be generated with `mix dialyzer --format short`. Just remember to put the output in quotes and braces to match the format above.
355+
356+
353357
#### List unused Filters
354358

355359
As filters tend to become obsolete (either because a discrepancy was fixed, or because the location

0 commit comments

Comments
 (0)