Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
debian
doc
include
m4
src
tests
tools
AUTHORS
COPYING
ChangeLog
CodingStyle.md
Doxyfile.in
INSTALL
Makefile.am
NEWS
README
README.ifcspec.md
README.md
aminclude.am
bootstrap.sh
configure.ac
devel-doxyfile.in
libtrap-varrun.conf.in
libtrap.pc.in
libtrap.spec.in
mdconvert.sh
service-ifc.md

README.md

libtrap

libtrap is a part of NEMEA Framework. It implements communication interfaces for NEMEA modules such as Modules and Detectors.

Since this is a low level development component, see NEMEA System repository for more general and user documentation.

Documentation

From time to time, we generate doxygen documentation. Having doxygen, it can be generated by make doc. (If you installed doxygen, you need to re-execute configure.)

The result can be found in doc, it contains two versions/levels of documentation. One is public doxygen doc - API for developers of NEMEA modules. The second is in devel doc - internal API for developers of libtrap.

Versioning

The result of libtrap compilation is a shared object (.so). To set version, we use mechanism of libtool, that has its own versioning.

How to increment version number of shared libraries. From libtool documentation amended with guidance from N. Boullis:

  1. It is probably not a good idea to update the version information several times between public releases, but rather once per public release. (This seems to be more an aesthetic consideration than a hard technical one.)
  2. If the library source code has changed at all since the last update, then increment REVISION (C:R:A' becomes C:R+1:A').
  3. If any interfaces have been added, removed, or changed since the last update, increment CURRENT, and set REVISION to 0.
  4. If any interfaces have been added since the last public release, then increment AGE.
  5. If any interfaces have been removed or changed since the last public release, then set AGE to 0. A changed interface means an incompatibility with previous version.