diff options
author | Micael Karlberg <bmk@erlang.org> | 2011-03-25 21:19:05 +0100 |
---|---|---|
committer | Micael Karlberg <bmk@erlang.org> | 2011-03-25 21:19:05 +0100 |
commit | 5396cae69c23d7d8b7bbd0433c3b31144254c7a9 (patch) | |
tree | a16e52267f14417155e938ee5f34cc5082efc314 /lib/dialyzer/test/README | |
parent | 143cc965e88ea2486c1e6b804f2ae033e870de2d (diff) | |
parent | f0e2f0b91ac4d45a64ddac511e0eba9b6ce01e92 (diff) | |
download | otp-5396cae69c23d7d8b7bbd0433c3b31144254c7a9.tar.gz otp-5396cae69c23d7d8b7bbd0433c3b31144254c7a9.tar.bz2 otp-5396cae69c23d7d8b7bbd0433c3b31144254c7a9.zip |
Merge branch 'dev' into bmk/snmp/support_ipv6_transport_address
Diffstat (limited to 'lib/dialyzer/test/README')
-rw-r--r-- | lib/dialyzer/test/README | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/lib/dialyzer/test/README b/lib/dialyzer/test/README new file mode 100644 index 0000000000..07340c7266 --- /dev/null +++ b/lib/dialyzer/test/README @@ -0,0 +1,44 @@ +------------------------------- +To add test cases in any suite: +------------------------------- + + 1) If the test requires dialyzer to analyze a single file place it in the + suite's 'src' directory. If analysis of more files is needed place them + all in a new directory in suite's 'src' directory. + + 2) Create a file with the same name as the test (if single file, omit the + extension else directory name) containing the expected result in suite's + 'result' directory. + + 3) Run './remake <suite>', where <suite> is the suite's name omitting + "_tests_SUITE". + +---------------------- +To create a new suite: +---------------------- + + 1) Create a directory with the suffix 'tests_SUITE_data'. The name should + describe the suite. + + 2) In the suite's directory create subdirectories 'src' and 'results' as + well as a 'dialyzer_options' file with the following content: + + {dialyzer_options, List}. + {time_limit, Limit}. + + where: + + List = a list of dialyzer options. Common case will be something + like [{warnings, Warnings}], where Warnings is a list of valid + '-W' prefixed dialyzer options without the 'W' prefix (e.g. + '-Wfoo' would be declared as [{warnings, [foo]}]. + Limit = the amount of time each test case is allowed to run. Must be + bigger than the time it takes the most time-consuming test to + finish. + + Any of these lines may be missing. Default options list is empty and + default time limit is 1 minute. + + 3) Add tests as described in previous section. + + 4) Add the resulting suite's name in the Makefile's MODULES variable. |