add quick start in README
[lttv.git] / ltt / branches / poly / README
1
2 This package contains the trace reading library and trace viewing tools for
3 the new Linux Trace Toolkit trace format. The associated kernel files to
4 generate the new traces are not yet included. In the meantime, a converter
5 from the old trace format to the new is provided. For more detailed information
6 see doc/developer/index.html
7
8 * Compiling
9
10 Some development libraries are needed for compiling :
11
12 gtk 2 development libraries (libgtk2.0, libgtk2.0-dev)
13 glib 2 development libraries (libglib2.0-0, libglib2.0-dev)
14 libpopt development libraries (libpopt0, libpopt-dev)
15 libpango development libraries (libpango1.0, libpango1.0-dev)
16
17 To compile the source tree from a tarball, simply follow these steps :
18
19 - run ./configure
20 - make
21 - make install
22
23 After running ./configure, you can also go in specific subdirectories and
24 use make, make install.
25
26
27 * Quick Start
28
29 - Create a trace
30 - Convert it
31 - Run ./lttv -m guievents -m guicontrolflow -m guievents -t path_to_trace
32
33
34 * Source Tree Structure
35
36 This is a sample of the suggested tree for Linux Trace Toolkit.
37
38 ltt: new trace format reading library (and converter).
39 README: This file.
40 debian: debian config files (currently empty).
41 doc: Documentation.
42 doc/user: User related documentation.
43 doc/developer: Developer related documentation.
44 kernel: Linux Trace Toolkit kernel code (currently empty).
45 lttd: Linux Trace Toolkit daemon (currently empty).
46 lttv: Linux Trace Toolkit trace analysis tool and viewer.
47 lttv/modules: Linux Trace Toolkit analysis tool and viewer plugin modules.
48 specs: RPM config files (currently empty).
49
50
51 * The rest of the tools
52
53 You must use the lastest versions of patches for the Linux Kernel. That includes
54 relayfs and ltt patches, available on the ltt-dev mailing list at
55 http://www.listserv.shafik.org/pipermail/ltt-dev/. You will find there the
56 lastest version of the trace daemon that must be used to create the traces. (in
57 the TraceToolkit package)
58
59 Once your traces are created, you must use the convert tool to create a trace in
60 the proper format from them.
61
62
63 * For Developers
64
65 This source tree is based on the autotools suite from GNU to simplify
66 portability. Here are some things you should have on your system in order to
67 compile the subversion repository tree :
68
69
70 GNU autotools (automake-1,7, autoconf2.50, autoheader2.50)
71 (make sure your system wide "automake" points to version 1.7!)
72 GNU Libtool
73 (for more information, go to http://www.gnu.org/software/autoconf/)
74
75 If you get the tree from the repository, you will need to use the autogen.sh
76 script. It calls all the GNU tools needed to prepare the tree configuration.
77
78
79
80 Mathieu Desnoyers
This page took 0.031791 seconds and 5 git commands to generate.