You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by kx...@apache.org on 2015/09/23 14:29:00 UTC
[06/50] rebar commit: updated refs/heads/import to 5dea85d
Add details on Dialyzer with "make check"
If Dialyzer hasn't been used on an account before, there won't be a PLT
file and "make check" will fail. Added info on that fact.
Project: http://git-wip-us.apache.org/repos/asf/couchdb-rebar/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-rebar/commit/1420a856
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-rebar/tree/1420a856
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-rebar/diff/1420a856
Branch: refs/heads/import
Commit: 1420a85670d959c95ca51eb8ad8d90f9e2bc11b7
Parents: 9455bc5
Author: Derek Brown <de...@gmail.com>
Authored: Thu Aug 7 13:27:12 2014 -0400
Committer: Derek Brown <de...@gmail.com>
Committed: Mon May 11 16:50:28 2015 -0400
----------------------------------------------------------------------
CONTRIBUTING.md | 8 ++++++++
1 file changed, 8 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb-rebar/blob/1420a856/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 78ebf09..9c88baf 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -76,6 +76,14 @@ To do that, run `make check`. If you didn't build via `make debug` at first, the
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.
+
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,
do not remove the