Document why context provider is ABI without a public header

[lttng-ust.git] / include / 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