From 221309e3604c231925b2441e41e29c5fed80dc4d Mon Sep 17 00:00:00 2001 From: Michael Jeanson Date: Tue, 2 Mar 2021 14:58:23 -0500 Subject: [PATCH] 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 Signed-off-by: Mathieu Desnoyers --- include/Makefile.am | 12 +++++++++--- include/ust-fd.h | 5 +++-- 2 files changed, 12 insertions(+), 5 deletions(-) diff --git a/include/Makefile.am b/include/Makefile.am index 61a09cdc..da53d953 100644 --- 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 9d764aef..ddebaa91 100644 --- 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 -- 2.34.1