~didier-barvaux/rohc/main

263 by Didier Barvaux
Fix bug #800829: No check for doxygen
1
Requirements
2
------------
3
4
The library itself does not require external resources. Optional configure
5
flags require external resources:
6
1176 by Didier Barvaux
Update the INSTALL file with the current configure options.
7
 --enable-app-fuzzer           requires libpcap.
8
 --enable-app-performance      requires libpcap.
9
 --enable-app-sniffer          requires libpcap.
10
 --enable-app-tunnel           requires TUN support.
11
 --enable-app-stats            requires libpcap, gnuplot, grep, sed, awk, sort,
12
                               and tr.
13
 --enable-linux-kernel-module  requires a Linux kernel
507 by Didier Barvaux
Update INSTALL with new configure options.
14
 --enable-doc                  requires doxygen and latex.
1176 by Didier Barvaux
Update the INSTALL file with the current configure options.
15
 --enable-doc-man              requires --enable-doc to be selected, doxy2man
16
                               and help2man.
776.1.5 by Didier Barvaux
Introduce new test_lsb_decode unit test for LSB decoding.
17
 --enable-rohc-tests           requires libpcap, cmocka, and sed.
519 by Didier Barvaux
configure: check for sort and tr tools if stats are enabled.
18
 --enable-rohc-tests-valgrind  requires --enable-rohc-tests to be selected,
19
                               valgrind, xsltproc, and grep.
263 by Didier Barvaux
Fix bug #800829: No check for doxygen
20
21
93 by Didier Barvaux
Update the AUTHORS, ChangeLog, INSTALL, NEWS and README files.
22
Libraries and tools
23
-------------------
24
25
Configure the libraries and tools:
26
161 by Didier Barvaux
Update INSTALL instructions to prefer ./configure rather than ./autogen.sh.
27
 $ ./configure --prefix=/path/to/installation/directory
28
507 by Didier Barvaux
Update INSTALL with new configure options.
29
 Note:
30
  - Use ./autogen.sh instead of ./configure if you are building from the source
31
    repository.
32
  - Add option --enable-examples if you want ot build the examples located in
33
    the examples/ directory.
93 by Didier Barvaux
Update the AUTHORS, ChangeLog, INSTALL, NEWS and README files.
34
35
Build the libraries and tools:
36
37
 $ make all
38
39
Install the libraries and tools:
1 by Didier Barvaux
Initial import of the ROHC compression/decompression library.
40
41
 $ make install
42
93 by Didier Barvaux
Update the AUTHORS, ChangeLog, INSTALL, NEWS and README files.
43
The libraries are now located in the /path/to/installation/directory/lib
44
directory, the header files in the /path/to/installation/directory/include
45
directory and the tools in the /path/to/installation/directory/bin directory.
46
47
In case of problem:
48
 - check you got the last release of the library (see README),
49
 - contact the mailing list (see README),
50
 - check the bugtracker for known bugs (see README).
51
1 by Didier Barvaux
Initial import of the ROHC compression/decompression library.
52
4 by Didier Barvaux
Update the INSTALL instructions (how to generate the doxygen documentation)
53
Documentation
54
-------------
55
56
HTML documentation can be generated from the source code thanks to Doxygen:
57
160 by Didier Barvaux
Update the way API documentation in HTML format is generated.
58
 $ ./configure --enable-doc
1176 by Didier Barvaux
Update the INSTALL file with the current configure options.
59
 $ make -C doc/
4 by Didier Barvaux
Update the INSTALL instructions (how to generate the doxygen documentation)
60
93 by Didier Barvaux
Update the AUTHORS, ChangeLog, INSTALL, NEWS and README files.
61
Open the ./doc/html/index.html file in your favorite web browser.
62
63
507 by Didier Barvaux
Update INSTALL with new configure options.
64
Tests
65
-----
66
67
The functional, robustness and non-regression tests may be run:
68
69
 $ ./configure --enable-rohc-tests
70
 $ make check
71
72
Add option --enable-rohc-tests-valgrind if you want to run tests within
73
valgrind.
74
75
76
Developers
77
-----------
78
79
Developers may be interested in additional configure options:
80
  --enable-fail-on-warning  causes the build to fail if a warning is emitted
81
                            by the compiler (-Werror)
1176 by Didier Barvaux
Update the INSTALL file with the current configure options.
82
  --enable-rohc-debug       enable library extra debug traces with performances
83
                            impact
84
  --enable-fortify-sources  enables some overflow protections (-D_FORTIFY_SOURCE=2)
85
  --enable-code-coverage    compute code coverage
507 by Didier Barvaux
Update INSTALL with new configure options.
86