summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDerek Brown <derekbrown121@gmail.com>2015-05-12 12:00:27 -0400
committerDerek Brown <derekbrown121@gmail.com>2015-05-12 12:14:57 -0400
commit65ac13bf13243c76210a2604b6a5f2f6aea441e9 (patch)
tree3897646facaf1dc487cd401d467c4218d7786eb0 /CONTRIBUTING.md
parent791db716b5a3a7671e0b351f95ddf24b848ee173 (diff)
downloadrebar-65ac13bf13243c76210a2604b6a5f2f6aea441e9.tar.gz
Update PLT detail for make build_plt
The PLT that rebar will have dialyzer use is now created with make build_plt - this commit explains that.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md7
1 files changed, 1 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9c88baf..968153e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -77,12 +77,7 @@ and [Dialyzer](http://www.erlang.org/doc/man/dialyzer.html), causing a test
failure.
If that happens, running `make clean` before running `make check` could solve the problem.
-Dialyzer requires a PLT (Persitent Lookup Table) to work with. By default, it will look for
-`$HOME/.dialyzer.plt` (alternatively, the `DIALYZER_PLT` environment variable can be set
-to point to a different location). If a PLT file cannot be found, Dialyzer (via `make check`) will
-fail- the output will indicate `"Could not read PLT file"`, including the path it tried to use.
-See the [Dialyzer man page](http://www.erlang.org/doc/man/dialyzer.html) or [this further explanation](http://www.erlang.org/doc/apps/dialyzer/dialyzer_chapter.html) for details on creating the initial
-PLT file.
+Dialyzer requires a PLT (Persitent Lookup Table) to work with, and `make check` will fail without it. The PLT that rebar uses needs to initially be created with `make build_plt`, and is named based on the version of Erlang/OTP in use. See the [Dialyzer man page](http://www.erlang.org/doc/man/dialyzer.html) or [this further explanation](http://www.erlang.org/doc/apps/dialyzer/dialyzer_chapter.html) for additional information.
If you change any of the files with known but safe to ignore Dialyzer warnings, you may
have to adapt the line number(s) in [dialyzer_reference](dialyzer_reference). If you do that,