common: document why spawn_viewer() is public

[lttng-tools.git] / src / common / spawn-viewer.h

diff --git a/src/common/spawn-viewer.h b/src/common/spawn-viewer.h
index 5789246821202bcff529f2288f81ab88a1b82c78..409c60ec86067fe023527c9c0942d314573fbb3a 100644 (file)
--- 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);