From 8844360e091d315a2952e3e4c954c3d6f7da9fee Mon Sep 17 00:00:00 2001 From: Mathieu Desnoyers Date: Mon, 12 Dec 2011 22:35:56 -0500 Subject: [PATCH] Update readme file, add example makefile Signed-off-by: Mathieu Desnoyers --- README | 37 ++++++++++++++++++++++++++---------- tests/hello/Makefile.example | 8 ++++++++ 2 files changed, 35 insertions(+), 10 deletions(-) create mode 100644 tests/hello/Makefile.example diff --git a/README b/README index 0b0d4bd3..114e3b25 100644 --- a/README +++ b/README @@ -47,7 +47,6 @@ INSTALLATION INSTRUCTIONS: - Run make. - Run make install. - Run ldconfig. - - See the manual for usage instructions. If compiling from the git repository, run ./bootstrap before running the configure script, to generate it. @@ -56,9 +55,25 @@ INSTALLATION INSTRUCTIONS: USAGE: - Create an instrumentation header following the tracepoint examples. - (see tracepoint.h and tests/hello/tp.h). - - Link application with -lust. - - (TODO: start tracing with the "lttng" command from lttng-tools) + See lttng/tracepoint.h, and examples. + - Either compile the Tracepoint probes with the application: + - Use "-I." for the compilation unit containing the tracepoint + provider include (e.g. tp.c). + - Link application with "-ldl -llttng-ust". + - Example: + tests/hello/ hello.c tp.c ust_tests_hello.h Makefile.example + - Or compile the Tracepoint probes separately from the application, + using dynamic linking: + - Compile the tracepoint provider with "-I.". + - Link the tracepoint provider with "-llttng-ust". + - Link application with "-ldl". + - Set a LD_PRELOAD environment to preload the tracepoint provider + shared object before starting the application when tracing is + needed. + - Example: + - tests/demo/ demo.c tp*.c ust_tests_demo*.h demo-trace + - Enable instrumentation and control tracing with the "lttng" command + from lttng-tools. See lttng-tools doc/quickstart.txt. ENVIRONMENT VARIABLES: @@ -71,7 +86,9 @@ ENVIRONMENT VARIABLES: "registration done" command before proceeding to execute the main program. The default is 3000ms (3 seconds). The timeout value is specified in milliseconds. The value 0 means "don't wait". The value - -1 means "wait forever". + -1 means "wait forever". Setting this environment variable to 0 is + recommended for applications with time constraints on the process + startup time. TRACE VIEWER: @@ -97,9 +114,6 @@ PACKAGE CONTENTS: - include The public header files that will be installed on the system. - - doc - The documentation. - - tests Various test programs @@ -119,9 +133,12 @@ PACKAGE CONTENTS: A static library shared between libust and lttng-tools, that provides functions that allow these components to communicate together. + - libringbuffer + The ring buffer implementation used within LTTng-UST. + - snprintf An asynchronous signal-safe version of snprintf. - - java + - liblttng-ust-java A simple library that uses JNI to allow tracing in java programs. - See java/README for build instructions. + See liblttng-ust-java/README for build instructions. diff --git a/tests/hello/Makefile.example b/tests/hello/Makefile.example new file mode 100644 index 00000000..c983f4c4 --- /dev/null +++ b/tests/hello/Makefile.example @@ -0,0 +1,8 @@ +# Example makefile for build outside of the LTTng-UST tree. + +hello: + ${CC} -O2 -I. -o hello -ldl -llttng-ust hello.c tp.c + +.PHONY: clean +clean: + rm -f hello -- 2.34.1