X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=tests%2Fregression%2Fust%2Flibc-wrapper%2FREADME;fp=tests%2Fregression%2Fust%2Flibc-wrapper%2FREADME;h=adcd4256069c8380c43f6fb7597fbad5475afd3e;hp=0000000000000000000000000000000000000000;hb=5836cdc2ccafa85a1813d5740133e8b652cfa7e3;hpb=37bd6c8e4c4a3d7054d97627e4fb4bef1d4612a6

diff --git a/tests/regression/ust/libc-wrapper/README b/tests/regression/ust/libc-wrapper/README
new file mode 100644
index 000000000..adcd42560
--- /dev/null
+++ b/tests/regression/ust/libc-wrapper/README
@@ -0,0 +1,22 @@
+libc-wrapper malloc/free tracing test
+-------------------------------------
+
+This test checks if tracing works correctly when applications are linked against
+the UST libc wrapper which provides tracepoints in the malloc and free libc
+functions.
+
+DESCRIPTION
+-----------
+
+The test application performs a series of calls to malloc()/free() and the
+resulting trace is checked for the presence of ust-libc:malloc and ust-libc:free
+events.
+
+DEPENDENCIES
+------------
+
+To run this test, you will need:
+
+  - lttng-tools (with python bindings)
+  - babeltrace
+  - python 3.0 or better