~ubuntu-branches/ubuntu/trusty/erlang/trusty

« back to all changes in this revision

Viewing changes to lib/dialyzer/test/README

  • Committer: Bazaar Package Importer
  • Author(s): Clint Byrum
  • Date: 2011-05-05 15:48:43 UTC
  • mfrom: (3.5.13 sid)
  • Revision ID: james.westby@ubuntu.com-20110505154843-0om6ekzg6m7ugj27
Tags: 1:14.b.2-dfsg-3ubuntu1
* Merge from debian unstable.  Remaining changes:
  - Drop libwxgtk2.8-dev build dependency. Wx isn't in main, and not
    supposed to.
  - Drop erlang-wx binary.
  - Drop erlang-wx dependency from -megaco, -common-test, and -reltool, they
    do not really need wx. Also drop it from -debugger; the GUI needs wx,
    but it apparently has CLI bits as well, and is also needed by -megaco,
    so let's keep the package for now.
  - debian/patches/series: Do what I meant, and enable build-options.patch
    instead.
* Additional changes:
  - Drop erlang-wx from -et
* Dropped Changes:
  - patches/pcre-crash.patch: CVE-2008-2371: outer level option with
    alternatives caused crash. (Applied Upstream)
  - fix for ssl certificate verification in newSSL: 
    ssl_cacertfile_fix.patch (Applied Upstream)
  - debian/patches/series: Enable native.patch again, to get stripped beam
    files and reduce the package size again. (build-options is what
    actually accomplished this)
  - Remove build-options.patch on advice from upstream and because it caused
    odd build failures.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
-------------------------------
 
2
To add test cases in any suite:
 
3
-------------------------------
 
4
 
 
5
  1) If the test requires dialyzer to analyze a single file place it in the
 
6
     suite's 'src' directory. If analysis of more files is needed place them
 
7
     all in a new directory in suite's 'src' directory.
 
8
 
 
9
  2) Create a file with the same name as the test (if single file, omit the
 
10
     extension else directory name) containing the expected result in suite's
 
11
     'result' directory.
 
12
 
 
13
  3) Run './remake <suite>', where <suite> is the suite's name omitting 
 
14
     "_tests_SUITE".
 
15
 
 
16
----------------------
 
17
To create a new suite:
 
18
----------------------
 
19
 
 
20
  1) Create a directory with the suffix 'tests_SUITE_data'. The name should 
 
21
     describe the suite.
 
22
 
 
23
  2) In the suite's directory create subdirectories 'src' and 'results' as
 
24
     well as a 'dialyzer_options' file with the following content:
 
25
 
 
26
        {dialyzer_options, List}.
 
27
        {time_limit, Limit}.
 
28
 
 
29
        where:
 
30
 
 
31
        List  = a list of dialyzer options. Common case will be something
 
32
                like [{warnings, Warnings}], where Warnings is a list of valid
 
33
                '-W' prefixed dialyzer options without the 'W' prefix (e.g.
 
34
                '-Wfoo' would be declared as [{warnings, [foo]}].
 
35
        Limit = the amount of time each test case is allowed to run. Must be
 
36
                bigger than the time it takes the most time-consuming test to
 
37
                finish.
 
38
     
 
39
     Any of these lines may be missing. Default options list is empty and
 
40
     default time limit is 1 minute.
 
41
 
 
42
  3) Add tests as described in previous section.
 
43
 
 
44
  4) Add the resulting suite's name in the Makefile's MODULES variable.