common: document why spawn_viewer() is public
[lttng-tools.git] / src / common / spawn-viewer.h
1 #ifndef LTTNG_SPAWN_VIEWER_H
2 #define LTTNG_SPAWN_VIEWER_H
3
4 /*
5 * Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
6 *
7 * SPDX-License-Identifier: GPL-2.0-only
8 *
9 */
10
11 #include <stdbool.h>
12
13 /*
14 * Read the trace by `exec()ing` the provided viewer program if any. If
15 * `opt_viewer` is NULL, try to read the trace with the default trace reader.
16 * On success, this function doesn't return.
17 * Returns -1 if the `opt_viewer` string or the default trace viewer can't be
18 * `exec()`.
19 *
20 * This symbol was mistakenly made public before the 2.12 release. It can't
21 * be removed (but it can be stubbed-out if necessary).
22 */
23 int spawn_viewer(const char *trace_path, char *opt_viewer, bool opt_live_mode);
24
25 #endif /* ifndef LTTNG_SPAWN_VIEWER_H */
This page took 0.02928 seconds and 4 git commands to generate.