X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=README;h=4b3053c84d523eaa5b45eca2941d8f7e8206b239;hb=464ea3a716c7d70f3f5cdd633ebff1ed17775aaf;hp=30ccb34d1a57903c2822f3618442b23571ef2fda;hpb=77ca1460d75b4f364aeb2002673569c69e59ecc8;p=lttng-ust.git diff --git a/README b/README index 30ccb34d..4b3053c8 100644 --- a/README +++ b/README @@ -72,11 +72,14 @@ USAGE: - If building the provider directly into the application, link the application with "-llttng-ust". - If building a static library for the provider, link the static - library with "-lllttng-ust". + library with "-llttng-ust". - Include the tracepoint provider header into all C files using the provider. - - Example: - - tests/hello/ hello.c tp.c ust_tests_hello.h Makefile.example.* + - Examples: + - doc/examples/easy-ust/ sample.c sample_component_provider.h + tp.c Makefile + - doc/examples/hello-static-lib/ hello.c tp.c ust_test_hello.h + Makefile 2) Compile the Tracepoint Provider separately from the application, using dynamic linking: @@ -94,14 +97,18 @@ USAGE: needed. Another way is to dlopen the tracepoint probe when needed by the application. - Example: - - tests/demo/ demo.c tp*.c ust_tests_demo*.h demo-trace + - doc/examples/demo demo.c tp*.c ust_tests_demo*.h demo-trace Makefile - - Enable instrumentation and control tracing with the "lttng" command - from lttng-tools. See lttng-tools doc/quickstart.txt. - Note about dlclose() usage: it is not safe to use dlclose on a provider shared object that is being actively used for tracing due to a lack of reference counting from lttng-ust to the used shared object. + - Enable instrumentation and control tracing with the "lttng" command + from lttng-tools. See lttng-tools doc/quickstart.txt. + - Note for C++ support: although an application instrumented with + tracepoints can be compiled with g++, tracepoint probes should be + compiled with gcc (only tested with gcc so far). + ENVIRONMENT VARIABLES: