From 2a93485bbdcde8c4f6a4b3b30d3b283f67c5bbd2 Mon Sep 17 00:00:00 2001 From: Pierre-Marc Fournier Date: Wed, 13 Jan 2010 15:35:22 -0500 Subject: [PATCH] update README --- README | 90 +++++++++++++++++++++++++++++++++++----------------------- 1 file changed, 55 insertions(+), 35 deletions(-) diff --git a/README b/README index 47904d49..d80ebf03 100644 --- a/README +++ b/README @@ -1,51 +1,71 @@ LTTNG USERSPACE TRACER +---------------------- Updated versions of this package may be found at: - git://git.dorsal.polymtl.ca/git/ust.git -Dependencies: + * Releases: http://lttng.org/files/ust/releases + * GitWeb: http://git.dorsal.polymtl.ca (project: ust) + * Git: git://git.dorsal.polymtl.ca/git/ust.git -- liburcu - Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney - * http://ltt.polymtl.ca/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary - * git://lttng.org/userspace-rcu.git -- libkcompat - Linux kernel userspace compatibility library. - * http://git.dorsal.polymtl.ca - * git://git.dorsal.polymtl.ca/git/libkcompat.git -Installation instruction: +PREREQUISITES: -- Download, compile and install liburcu and libkcompat. -- In this package's tree, run ./configure. -- Run make. -- Run make install. -- Run ldconfig. -- See the manual in the doc/ directory for usage instructions. + - liburcu -Package contents: + Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney + * Releases: http://lttng.org/files/ust/releases + * GitWeb: http://lttng.org/cgi-bin/gitweb.cgi?p=userspace-rcu.git;a=summary + * Git: git://lttng.org/userspace-rcu.git -- libust - The actual userspace tracing library that must be linked to the - instrumented programs. + -> This release was tested with liburcu v0.0 -- ustctl - A program to control the tracing of userspace applications. It can list - markers, start the tracing, stop the tracing, enable/disable markers, etc. -- ustd - The daemon that collects trace data and writes it to the disk. + - libkcompat -- Documentation + Linux kernel userspace compatibility library. + (Provides userspace ports of some kernel APIs.) + * Releases: http://lttng.org/files/ust/releases + * GitWeb: http://git.dorsal.polymtl.ca (project: libkcompat) + * Git: git://git.dorsal.polymtl.ca/git/libkcompat.git -- hello - An example application that uses the userspace tracer. + -> This release was tested with libkcompat v0.0 -- libmallocwrap - An example library that can be LD_PRELOAD'ed to instrument calls to malloc() - in any program without need to recompile it. -- libinterfork - A library that is LD_PRELOAD'ed, and that hijacks calls to several system - calls in order to trace across these calls. + +INSTALLATION INSTRUCTION: + + - Download, compile and install liburcu and libkcompat. + - In this package's tree, run ./configure. + - Run make. + - Run make install. + - Run ldconfig. + - See the manual in the doc/ directory for usage instructions. + + + +PACKAGE CONTENTS: + + - libust + The actual userspace tracing library that must be linked to the + instrumented programs. + + - ustctl + A program to control the tracing of userspace applications. It can list + markers, start the tracing, stop the tracing, enable/disable markers, etc. + + - ustd + The daemon that collects trace data and writes it to the disk. + + - Documentation + + - hello + An example application that uses the userspace tracer. + + - libmallocwrap + An example library that can be LD_PRELOAD'ed to instrument calls to malloc() + in any program without need to recompile it. + + - libinterfork + A library that is LD_PRELOAD'ed, and that hijacks calls to several system + calls in order to trace across these calls. -- 2.34.1