projects
/
lttng-tools.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Update coding style. Add error handling section
[lttng-tools.git]
/
README
diff --git
a/README
b/README
index 48564002c7b108d86b1033c00e54182957656591..1898af98472ef7686006bb9bade0024702a5e810 100644
(file)
--- a/
README
+++ b/
README
@@
-28,6
+28,18
@@
REQUIREMENTS:
* Debian/Ubuntu package: libpopt-dev
* Debian/Ubuntu package: libpopt-dev
+ - SWIG >= 2.0 (optional)
+ Needed for Python bindings
+
+ * Debian/Ubuntu package: swig2.0
+
+ - python-dev (optional)
+ Python headers
+
+ * Debian/Ubuntu package: python-dev
+
+ - For kernel tracing: modprobe
+
For developers using the git tree:
This source tree is based on the autotools suite from GNU to simplify
For developers using the git tree:
This source tree is based on the autotools suite from GNU to simplify
@@
-38,6
+50,11
@@
compile the git repository tree :
(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/)
(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)
+- flex >= 2.5.35
+- bison >= 2.4
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
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
@@
-55,17
+72,25
@@
INSTALLATION INSTRUCTIONS:
If compiling from the git repository, run ./bootstrap before running
the configure script, to generate it.
If compiling from the git repository, run ./bootstrap before running
the configure script, to generate it.
+ If you want Python bindings, run ./configure --enable-python-bindings.
+
USAGE:
Please see doc/quickstart.txt to help you start tracing. You can also use the
-h/--help command on 'lttng' and all other commands offered in this tool (Ex:
lttng enable-event -h).
USAGE:
Please see doc/quickstart.txt to help you start tracing. You can also use the
-h/--help command on 'lttng' and all other commands offered in this tool (Ex:
lttng enable-event -h).
+A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
+helps you understand how to stream a LTTng 2.0 trace.
+
+A Python HOWTO can be found in doc/python-howto.txt which quickly
+helps you understand how to use the Python module to control the LTTng API.
+
PACKAGE CONTENTS:
This package contains the following elements:
PACKAGE CONTENTS:
This package contains the following elements:
- - liblttngctl
+ - liblttng
-
ctl
The LTTng tracing control library.
- libsessiond-comm (internal)
The LTTng tracing control library.
- libsessiond-comm (internal)
@@
-87,6
+112,18
@@
PACKAGE CONTENTS:
- libhashtable (internal)
Library wrapper over URCU hashtables.
- libhashtable (internal)
Library wrapper over URCU hashtables.
+ - libcommon (internal)
+ Contains multiple useful function call used by the whole tree.
+
+ - libcompat (internal)
+ Compatibility library mostly for FreeBSD and Linux.
+
+ - librelayd (internal)
+ Library for all relayd interactions over the network.
+
+ - lttng-relayd
+ The relay daemon used for network streaming
+
- lttng-consumerd
The consumer daemon which uses libconsumer.
- lttng-consumerd
The consumer daemon which uses libconsumer.
@@
-104,3
+141,6
@@
PACKAGE CONTENTS:
- doc
Various documentations and quickstart guide.
- doc
Various documentations and quickstart guide.
+
+ - extras
+ Contains extra data such as bash completion file.
This page took
0.024614 seconds
and
4
git commands to generate.