From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Thu, 1 Apr 2021 03:38:07 +0000 (-0400)
Subject: common: document why spawn_viewer() is public
X-Git-Tag: v2.13.0-rc1~175
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=c84305ff874d7c3226b47cc88dccf7fbac2f0a52;p=lttng-tools.git

common: document why spawn_viewer() is public

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I09574ebd82bb583db5a7acec2b8f129a7dcd36fc
---

diff --git a/src/common/spawn-viewer.h b/src/common/spawn-viewer.h
index 578924682..409c60ec8 100644
--- a/src/common/spawn-viewer.h
+++ b/src/common/spawn-viewer.h
@@ -16,6 +16,9 @@
  * On success, this function doesn't return.
  * Returns -1 if the `opt_viewer` string or the default trace viewer can't be
  * `exec()`.
+ *
+ * This symbol was mistakenly made public before the 2.12 release. It can't
+ * be removed (but it can be stubbed-out if necessary).
  */
 int spawn_viewer(const char *trace_path, char *opt_viewer, bool opt_live_mode);