From ebb6ebd5548553f617ce313af0bc757c0d41c30b Mon Sep 17 00:00:00 2001 From: David Goulet Date: Wed, 20 Jul 2011 11:07:31 -0400 Subject: [PATCH] Fix README and add doc to tarball Signed-off-by: David Goulet --- Makefile.am | 3 +- README | 77 ++++++++++++++++++++++++++----------------------- configure.ac | 1 + doc/Makefile.am | 1 + 4 files changed, 45 insertions(+), 37 deletions(-) create mode 100644 doc/Makefile.am diff --git a/Makefile.am b/Makefile.am index 3d86d6e66..94b0c376d 100644 --- a/Makefile.am +++ b/Makefile.am @@ -10,4 +10,5 @@ SUBDIRS = liblttsessiondcomm \ ltt-kconsumerd \ ltt-sessiond \ tests \ - include + include \ + doc diff --git a/README b/README index af6e86488..389f3eda1 100644 --- a/README +++ b/README @@ -5,60 +5,65 @@ Please visit http://lttng.org for more information. Latest development can be found at: - * Gitweb : http://git.lttng.org/lttng-tools.git/ - * Git : git://git.lttng.org/lttng-tools.git + * Gitweb : http://git.lttng.org/lttng-tools.git/ + * Git : git://git.lttng.org/lttng-tools.git -PREREQUISITES: +REQUIREMENTS: - - liburcu - Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney - - -> Tested with liburcu >= v0.5.4 + - liburcu + Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney - * Debian/Ubuntu package: liburcu-dev - * Git : git://lttng.org/userspace-rcu.git - * Website: http://lttng.org/urcu + -> Tested with liburcu >= v0.5.4 - - libustctl - LTTng user-space tracer control library + * Debian/Ubuntu package: liburcu-dev + * Git : git://lttng.org/userspace-rcu.git + * Website: http://lttng.org/urcu - Needed for interaction with that tracer. + - libpopt + Library for parsing command line parameters - - liblttctl - LTTng kernel tracer control library - - Needed for interaction with that tracer. + * Debian/Ubuntu package: libpopt-dev INSTALLATION INSTRUCTIONS: - - Download, compile and install liburcu, libuuid, libustctl and liblttctl - - In this package's tree, run ./configure. - - Run make. - - Run make install. - - Run ldconfig. + - Download, compile and install the prerequisites. + Then: + $ ./configure + $ make + $ sudo make install + $ sudo ldconfig If compiling from the git repository, run ./bootstrap before running the configure script, to generate it. PACKAGE CONTENTS: - This package contains the following elements: + This package contains the following elements: + + - liblttngctl + The LTTng tracing control library. + + - liblttsessiondcomm + The ltt-sessiond communication library. In order to talk with ltt-sessiond, + thiis library must be used. + + - libkernelctl + Kernel tracer control and ioctl definitions. - - liblttngctl - The LTTng trace control library. + - liblttkconsumerd + Library for Kernel trace consumer. - - liblttsessiondcomm - The ltt-sessiond communication library. In order to talk with ltt-sessiond, - thi library must be used. + - ltt-kconsumerd + The Kernel consumer daemon which uses liblttkconsumerd. - - ltt-sessiond - The LTTng session daemon binary. + - ltt-sessiond + The LTTng session daemon binary. - - lttng - The LTTng tracer command line control tool. + - lttng + The LTTng tracer command line control tool. - - include - The liblttngctl API header file. + - include (lttng.h --> installed in $(includedir)/lttng/lttng.h) + The liblttngctl API header file. - - tests - Various test programs. + - tests + Various test programs. diff --git a/configure.ac b/configure.ac index 266117383..a051887a6 100644 --- a/configure.ac +++ b/configure.ac @@ -52,6 +52,7 @@ AC_CONFIG_FILES([ ltt-sessiond/Makefile lttng/Makefile tests/Makefile + doc/Makefile ]) AC_OUTPUT diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 000000000..9ec9e42b1 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1 @@ +EXTRA_DIST = quickstart.txt session-daemon-model.txt -- 2.34.1