X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=README;h=2a335ceccac6d2cddecf82591525c56e8aecc7f4;hb=739b96c6d55a8bf7ca8fbda09a3f57dbad9b4838;hp=dadcd1f5ac5f91975d904cf6d6644c460fe1c0e0;hpb=a16877ab2e893f2cce515b0e5368f66c2609e286;p=lttng-ust.git diff --git a/README b/README index dadcd1f5..2a335cec 100644 --- a/README +++ b/README @@ -52,6 +52,11 @@ INSTALLATION INSTRUCTIONS: If compiling from the git repository, run ./bootstrap before running the configure script, to generate it. + Note that configure sets '/usr/local' as the default prefix for files it + installs. However, this path is not part of most distributions' default + library path which will cause builds depending on liblttng-ust to fail unless + '-L/usr/local/lib' is added to LDFLAGS. You may provide a custom prefix to + configure by using the --prefix switch. USAGE: @@ -75,8 +80,11 @@ USAGE: 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 +102,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: