_SUITE.erl
and that the files be located in the $(TEST_DIR) directory.
-This defaults to test/.
The CT_OPTS
variable allows you to set extra Common Test
+This defaults to test/.
The CT_OPTS
variable allows you to set extra Common Test
options. Options are documented in the
Common Test user guide.
You can use it to set Common Test hooks, for example:
CT_OPTS = -ct_hooks cowboy_ct_hook
The CT_SUITES
variable can be used to override what
@@ -47,7 +47,7 @@ Common Test suites Erlang.mk will be aware of. It does
not normally need to be set as Erlang.mk will find the
test suites automatically.
The name of the suite is the part before _SUITE.erl
.
If the file is named http_SUITE.erl, the test suite
-is http
:
CT_SUITES = http ws
To run all tests (including Common Test):
$ make tests
To run all tests and static checks (including Common Test):
$ make check
You can also run Common Test separately:
$ make ct
Erlang.mk will create targets for all test suites it finds.
+is http
:
CT_SUITES = http ws
To run all tests (including Common Test):
$ make tests
To run all tests and static checks (including Common Test):
$ make check
You can also run Common Test separately:
$ make ct
Erlang.mk will create targets for all test suites it finds.
If you have a file named test/http_SUITE.erl, then the
target ct-http
will run that specific test suite:
$ make ct-http
Erlang.mk provides a convenient way to run a specific
group or a specific test case within a specific group,
diff --git a/guide/dialyzer.html b/guide/dialyzer.html
index 0ec7be7..0c9f537 100644
--- a/guide/dialyzer.html
+++ b/guide/dialyzer.html
@@ -44,7 +44,7 @@ dependencies of the application or applications you are
currently working on, including standard applications in
Erlang/OTP itself.
Dialyzer can generate this PLT file. Erlang.mk includes rules
to automatically generate the PLT file when it is missing.
Once the PLT file is generated, Dialyzer can perform the
-analysis in record time.
In a typical usage scenario, no variable needs to be set.
+analysis in record time.
In a typical usage scenario, no variable needs to be set.
The defaults should be enough. Do note however that the
dependencies need to be set properly using the DEPS
and
LOCAL_DEPS
variables.
The DIALYZER_PLT
file indicates where the PLT file will
@@ -59,7 +59,7 @@ The former one defines which directories should be part
of the analysis. The latter defines what extra warnings
Dialyzer should report.
Note that Erlang.mk enables the race condition warnings
by default. As it can take considerably large resources
-to run, you may want to disable it on larger projects.
To perform an analysis, run the following command:
$ make dialyze
This will create the PLT file if it doesn’t exist.
The analysis will also be performed when you run the
+to run, you may want to disable it on larger projects.
To perform an analysis, run the following command:
$ make dialyze
This will create the PLT file if it doesn’t exist.
The analysis will also be performed when you run the
following command, alongside tests:
$ make check
You can use the plt
target to create the PLT file if
it doesn’t exist. This is normally not necessary as
Dialyzer creates it automatically.
The PLT file will be removed when you run make distclean
.
diff --git a/guide/edoc.html b/guide/edoc.html
index 9d68a75..e24967c 100644
--- a/guide/edoc.html
+++ b/guide/edoc.html
@@ -33,7 +33,17 @@ div.navfooter{margin-bottom:1em}