annotate erlang/erldc/README.txt @ 47:44045db8fa5f

PyCObject/PyCapsule not usable as type annotation
author Tassilo Philipp
date Fri, 13 Nov 2020 18:04:05 +0100
parents 3abd4f1ab473
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17
739c40f35a6a - update READMEs
cslag
parents: 15
diff changeset
1 dyncall erlang bindings (NIF)
739c40f35a6a - update READMEs
cslag
parents: 15
diff changeset
2
739c40f35a6a - update READMEs
cslag
parents: 15
diff changeset
3
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
4 BUILD/INSTALLATION
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
5 ==================
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
6
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
7 1) make sure dyncall is built and libraries/headers are in include paths or
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
8 CFLAGS points to them, etc.. Same goes for erlang headers/libs.
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
9
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
10 2) Build this erlang NIF:
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
11
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
12 make
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
13
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
14 3) To install, pick correct install paths by defining PREFIX (if needed, e.g.
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
15 for stage dir) and ERLANG_INST_DIR (e.g. /usr/lib64/erlang,
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
16 /usr/local/lib/erlang, ...):
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
17
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
18 make ERLANG_INST_DIR=/erlang/in/this/dir install
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
19
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
20 Erlang doesn't use pkg-config, so it's up to you to point to set the flags to
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
21 point to correct paths at build and install-time.
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
22
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
23 The makefile is meant to be portable, at least across *nix.
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
24
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
25
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
26 RUNNING TESTS
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
27 =============
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
28
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
29 Unit tests (via common test):
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
30
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
31 make tests
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
32
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33 Static analysis (via dialyzer):
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
34
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
35 make build-plt
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
36 make dialyze
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
37
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
38
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
39 USING
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
40 =====
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
41
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
42 Examine the test suites for several examples.
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
43
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
44 Dyncall is built as an OTP library application, so there's nothing
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
45 to start or stop.
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
46
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
47
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
48 TODO
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
49 ====
41
3abd4f1ab473 - erlang binding: update to dc 1.1 and added note about missing feature
Tassilo Philipp
parents: 17
diff changeset
50 - signature chars used to indicate calling conventions are not supported yet!
15
1673ab696715 - erlang binding ToDo update in readme
cslag
parents: 12
diff changeset
51 - callback support
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
52
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
53
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
54 AUTHORS
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
55 =======
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
56 Erik Mackdanz <erikmack@gmail.com>
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
57