annotate erlang/erldc/README.txt @ 12:079718588eb6

made erlang binding work with system *installed* dyncall: - made build use static libraries (used .o files directly) - removed custom flags for include path and relying on CFLAGS now - change cc to $(CC) - readme update with build instructions, etc.
author cslag
date Sat, 26 Mar 2016 15:55:50 +0100
parents 0cfcc391201f
children 1673ab696715
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
1 BUILD/INSTALLATION
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
2 ==================
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
3
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
4 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
5 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
6
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
7 2) Build this erlang NIF:
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
8
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
9 make
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
10
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
11 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
12 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
13 /usr/local/lib/erlang, ...):
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
14
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
15 make ERLANG_INST_DIR=/erlang/in/this/dir install
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
16
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
17 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
18 point to correct paths at build and install-time.
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
19
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
20 The makefile is meant to be portable, at least across *nix.
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
21
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
22
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
23 RUNNING TESTS
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
24 =============
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
25
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
26 Unit tests (via common test):
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
27
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
28 make tests
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
29
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
30 Static analysis (via dialyzer):
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
31
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
32 make build-plt
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
33 make dialyze
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
34
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
35
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
36 USING
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 Examine the test suites for several examples.
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
40
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
41 Dyncall is built as an OTP library application, so there's nothing
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
42 to start or stop.
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
43
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
44
0
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
45 TODO
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
46 ====
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
47
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
48
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
49 AUTHORS
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
50 =======
0cfcc391201f initial from svn dyncall-1745
Daniel Adler
parents:
diff changeset
51 Erik Mackdanz <erikmack@gmail.com>
12
079718588eb6 made erlang binding work with system *installed* dyncall:
cslag
parents: 0
diff changeset
52