X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=README;h=2d1d570fb6dea370a42279b0d904501a09a6b72d;hb=13ef5c0efe5894668297bfa10f1304c40866c054;hp=032fd946d7db213fb6af5da03eddead85476eec2;hpb=a4c5d022e0ffb2a26be6ac925bedfd9e903ea8f3;p=ust.git diff --git a/README b/README index 032fd94..2d1d570 100644 --- a/README +++ b/README @@ -11,13 +11,12 @@ Updated versions of this package may be found at: * Git: git://git.dorsal.polymtl.ca/git/ust.git - PREREQUISITES: - liburcu Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney - -> This release was tested with liburcu v0.4.3 + -> This release was tested with liburcu v0.5.4 * Debian/Ubuntu package: liburcu-dev * Website: http://lttng.org/urcu @@ -35,6 +34,8 @@ INSTALLATION INSTRUCTIONS: - Run ldconfig. - See the manual for usage instructions. + If compiling from the git repository, run ./bootstrap before running + the configure script, to generate it. TRACE VIEWER: @@ -42,7 +43,13 @@ TRACE VIEWER: LTTV is used for viewing UST traces. LTTV may be obtained at http://lttng.org in the Downloads section. - This release has been tested with LTTV 0.12.30. + This release has been tested with LTTV 0.12.32. + + +CONTACT: + + Maintainer: Mathieu Desnoyers + Mailing list: ltt-dev@lists.casi.polymtl.ca PACKAGE CONTENTS: @@ -60,7 +67,7 @@ PACKAGE CONTENTS: - include The public header files that will be installed on the system. - - ustd + - ust-consumerd The daemon that collects trace data and writes it to the disk. - doc @@ -75,14 +82,19 @@ PACKAGE CONTENTS: - libustfork A library that is LD_PRELOAD'ed, and that hijacks calls to several system - calls in order to trace across these calls. + calls in order to trace across these calls. It _has_ to be LD_PRELOAD'ed + in order to hijack calls. In contrast, libust may be linked at build time. - - libustcmd + - libustctl A library to control tracing in other processes. Used by ustctl. - libustcomm - A static library shared between libust, ustd and libustcmd, that provides - functions that allow these components to communicate together. + A static library shared between libust, ust-consumerd and libustctl, that + provides functions that allow these components to communicate together. + + - libustconsumer + A library to create ust consumers by registering callbacks, used by + ust-consumerd. - snprintf An asynchronous signal-safe version of snprintf.