X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=README;h=aabdf5a6267db9fd9b8032bc1cbf62f5ee473cd8;hp=afdbf2311c10da73d195072551b3348ef13a4f14;hb=71a76062f23acce858b0d714e3414617e0e2b440;hpb=aeff77c885be425a8247b2143469fdd400ef68c0 diff --git a/README b/README index afdbf2311..aabdf5a62 100644 --- a/README +++ b/README @@ -10,20 +10,44 @@ Latest development can be found at: REQUIREMENTS: + - Linux kernel >= 2.6.27 + pipe2(), epoll_create1() and SOCK_CLOEXEC are needed to run the session + daemon. There were introduce in the Linux 2.6.27 + - liburcu Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney - -> Tested with liburcu >= v0.5.4 + -> Tested with liburcu >= v0.6.6 * Debian/Ubuntu package: liburcu-dev - * Git : git://lttng.org/userspace-rcu.git + * Git : git://git.lttng.org/userspace-rcu.git * Website: http://lttng.org/urcu - - libpopt + - libpopt >= 1.13 Library for parsing command line parameters * Debian/Ubuntu package: libpopt-dev + - For kernel tracing: modprobe + +For developers using the git tree: + +This source tree is based on the autotools suite from GNU to simplify +portability. Here are some things you should have on your system in order to +compile the git repository tree : + +- GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50) + (make sure your system wide "automake" points to a recent version!) +- GNU Libtool >=2.2 + (for more information, go to http://www.gnu.org/software/autoconf/) +- GNU Gold >= 2.22 + (Before this version we hit a known bug documented at: + http://sourceware.org/bugzilla/show_bug.cgi?id=11317) + +If you get the tree from the repository, you will need to use the "bootstrap" +script in the root of the tree. It calls all the GNU tools needed to prepare the +tree configuration. + INSTALLATION INSTRUCTIONS: - Download, compile and install the prerequisites. @@ -49,20 +73,29 @@ PACKAGE CONTENTS: - liblttngctl The LTTng tracing control library. - - liblttsessiondcomm - The ltt-sessiond communication library. In order to talk with ltt-sessiond, - thiis library must be used. + - libsessiond-comm (internal) + The lttng-sessiond communication library. In order to talk with + lttng-sessiond, this library must be used. - - libkernelctl + - libkernel-ctl (internal) Kernel tracer control and ioctl definitions. - - liblttkconsumerd - Library for Kernel trace consumer. + - libconsumer (internal) + Library for Kernel and (optionally) UST trace consumer. + + - libkernel-consumer (internal) + Library for Kernel consumer control + + - libust-consumer (internal) + Library for UST consumer control - - ltt-kconsumerd - The Kernel consumer daemon which uses liblttkconsumerd. + - libhashtable (internal) + Library wrapper over URCU hashtables. - - ltt-sessiond + - lttng-consumerd + The consumer daemon which uses libconsumer. + + - lttng-sessiond The LTTng session daemon binary. - lttng @@ -73,3 +106,6 @@ PACKAGE CONTENTS: - tests Various test programs. + + - doc + Various documentations and quickstart guide.