Document why context provider is ABI without a public header

The context provider feature is part of the ABI and used by the Java jni
interface. However, some test code and documentation needs to be written
before it is exposed to users with a public header.

Change-Id: I24fcd5cf4a79e3f3c95654dd915dbe7c5380b66c
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 c338205c9ec2518daa94d1a3c4dd7bd6ab7201ff..cafcb7c7cb062f4d8ca6ed807f9c0fd2758ad488 100644 (file)
--- a/include/Makefile.am
+++ b/include/Makefile.am
@@ -60,7 +60,10 @@ noinst_HEADERS = \
        ust-bitfield.h \
        ust-dlfcn.h \
        ust-dynamic-type.h \
-       ust-context-provider.h \
        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.
+noinst_HEADERS += \
+       ust-context-provider.h

diff --git a/include/ust-context-provider.h b/include/ust-context-provider.h
index 332f9144a531735038e73135397fc84d39da1874..0425a31d6e398f1989c5a90c176034eafc5ab227 100644 (file)
--- a/include/ust-context-provider.h
+++ b/include/ust-context-provider.h
@@ -2,6 +2,10 @@
  * SPDX-License-Identifier: MIT
  *
  * Copyright (C) 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *
+ * The context provider feature is part of the ABI and used by the Java jni
+ * interface. This header should be moved to the public header directory once
+ * some test code and documentation is written.
  */
 
 #ifndef _LTTNG_UST_CONTEXT_PROVIDER_H