From 28b9540bbb6021c114447575debd02f8b9ff4794 Mon Sep 17 00:00:00 2001 From: Michael Jeanson Date: Thu, 25 Feb 2021 10:29:48 -0500 Subject: [PATCH] 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 Signed-off-by: Mathieu Desnoyers --- include/Makefile.am | 5 ++++- include/ust-context-provider.h | 4 ++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/include/Makefile.am b/include/Makefile.am index c338205c..cafcb7c7 100644 --- 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 332f9144..0425a31d 100644 --- 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 + * + * 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 -- 2.34.1