From 2615de09cbdc7ef9b62db08c182bd75acfad6487 Mon Sep 17 00:00:00 2001 From: Pierre-Marc Fournier Date: Fri, 8 May 2009 09:36:25 -0400 Subject: [PATCH] add more readmes --- README | 37 +++++++++++++++++++++++++++++++++++++ ust/README | 3 +++ ustd/README | 3 +++ 3 files changed, 43 insertions(+) create mode 100644 README create mode 100644 ust/README create mode 100644 ustd/README diff --git a/README b/README new file mode 100644 index 0000000..18874e8 --- /dev/null +++ b/README @@ -0,0 +1,37 @@ +LTTNG USERSPACE TRACER + +NOTE: THIS LIBRARY HAS NOT BEEN RELEASED YET BECAUSE ALTOUGH IT IS LICENCED AS +LGPL, IT CAN ONLY BE USED AS GPL BECAUSE IT DEPENDS ON GPL LIBRARIES. IT WILL BE +RELEASED AS SOON AS THESE ISSUES ARE RESOLVED. + +Dependencies: + +- liburcu-pmf + Userspace RCU library, pmf patches. + http://git.dorsal.polymtl.ca + +- libkcompat + Linux kernel userspace compatibility library. + http://git.dorsal.polymtl.ca + +Package contents: + +- libust + The actual userspace tracing library that must be linked to the + instrumented programs. + +- ust + 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. diff --git a/ust/README b/ust/README new file mode 100644 index 0000000..69e513b --- /dev/null +++ b/ust/README @@ -0,0 +1,3 @@ +ust is a helper application used to control tracing on programs that support tracing. + +It can list markers, enable/disable markers, start tracing and stop tracing. diff --git a/ustd/README b/ustd/README new file mode 100644 index 0000000..8fcd218 --- /dev/null +++ b/ustd/README @@ -0,0 +1,3 @@ +This is ustd, the UST daemon. + +This daemon is used to collect the traces for the traced programs. -- 2.34.1