Document why the fd tracker is ABI without a public header

The fd tracker feature is part of the ABI and used by liblttng-ust-fd.
However, some test code and documentation needs to be written before it
is exposed to users with a public header.

Change-Id: I601e11328426904c121ff6cd9668abbd83006f68
Signed-off-by: Michael Jeanson <mjeanson@efficios.com>
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/include/Makefile.am b/include/Makefile.am
index 61a09cdc854c1b4f854dd9f47a9091096a2db61c..da53d95324b52c2de02477967b4cc6e30b8a5175 100644 (file)
--- a/include/Makefile.am
+++ b/include/Makefile.am
@@ -54,7 +54,6 @@ noinst_HEADERS = \
        ust-bitmap.h \
        ust-comm.h \
        ust-compat.h \
-       ust-fd.h \
        ust-tid.h \
        ust-bitfield.h \
        ust-dlfcn.h \
@@ -62,7 +61,14 @@ noinst_HEADERS = \
        ust-helper.h \
        ust-share.h
 
-# Should be moved to the public headers when tested and documented. The symbols
-# are still part of the ABI and used by the Java jni interface.
+
+# These headers should be moved to the public headers when tested and
+# documented. The symbols are still part of the ABI.
+
+# Used by the Java jni interface.
 noinst_HEADERS += \
        ust-context-provider.h
+
+# Used by liblttng-ust-fd
+noinst_HEADERS += \
+       ust-fd.h \

diff --git a/include/ust-fd.h b/include/ust-fd.h
index 9d764aefa20fd8f39795e84c013a3d455b5fc4fc..ddebaa91affed11018a8a7dba95da981364021f6 100644 (file)
--- a/include/ust-fd.h
+++ b/include/ust-fd.h
@@ -8,8 +8,9 @@
 #define _LTTNG_UST_FD_H
 
 /*
- * This header is meant for liblttng and libust internal use ONLY.
- * These declarations should NOT be considered stable API.
+ * The fd tracker feature is part of the ABI and used by liblttng-ust-fd.
+ * However, some test code and documentation needs to be written before it is
+ * exposed to users with a public header.
  */
 
 #include <stdio.h>