Documentation: clarify API backward compatibility comment
authorMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Fri, 28 May 2021 15:23:46 +0000 (11:23 -0400)
committerMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Fri, 16 Jul 2021 14:51:47 +0000 (10:51 -0400)
Considering that the ABI (soname major version) and API version can
evolve independently in the future, remove references to the soname
major version from the API compatibility documentation.

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Change-Id: Ic632c3d0f0940a689139a8e1d19dc5766382327e

include/lttng/ust-api-compat.h

index af9c272b64cde614693d5079feaaa412b099c58c..c0f520111d476898480df57f63fcb1a355e0668d 100644 (file)
 #define _LTTNG_UST_API_COMPAT_H
 
 /*
 #define _LTTNG_UST_API_COMPAT_H
 
 /*
- * In order to disable compatibility API for a range of soname major
- * versions, define LTTNG_UST_COMPAT_API_VERSION to the oldest major
- * version API for which to provide compatibility.
+ * The compat API version controls backward API compatibility at the
+ * source-code level.
+ *
+ * In order to disable compatibility API for a range of API versions, define
+ * LTTNG_UST_COMPAT_API_VERSION to the oldest API version for which to provide
+ * compatibility.
  *
  * If LTTNG_UST_COMPAT_API_VERSION is undefined, API compatibility for
  * all API versions is provided.
  * If LTTNG_UST_COMPAT_API_VERSION is defined to N, API compatibility
  *
  * If LTTNG_UST_COMPAT_API_VERSION is undefined, API compatibility for
  * all API versions is provided.
  * If LTTNG_UST_COMPAT_API_VERSION is defined to N, API compatibility
- * for soname N or higher is provided, leaving out (not compiling)
- * compatibility for soname lower than N.
+ * for versions N or higher is provided, thus not defining compatibility macros
+ * for versions lower than N.
  */
 
 #ifndef LTTNG_UST_COMPAT_API_VERSION
  */
 
 #ifndef LTTNG_UST_COMPAT_API_VERSION
This page took 0.025856 seconds and 4 git commands to generate.