~lttng/lttng-ust/lttng-ust

« back to all changes in this revision

Viewing changes to doc/man/lttng-ust.3.txt

  • Committer: Mathieu Desnoyers
  • Date: 2023-10-20 15:57:20 UTC
  • Revision ID: git-v1:8bc1125eb851b2c52d3263c2992e6806017e98e7
Revert "Add support for LTTNG_UST_HOME"

This reverts commit 90d125c709f566f3663bf84677f100134cc618e0.

After discussion with Jeremie, we want to introduce two (not one)
environment variables:

- LTTNG_UST_APP_PATH,
- LTTNG_UST_CTL_PATH.

to accomodate use-cases where a sessiond within a container is traced by
a sessiond in the parent container. In that situation, we want the
sessiond in the parent container to access the tracee through the
LTTNG_UST_CTL_PATH, without making the unix sockets for tracing control
visible to the child container.

Therefore, remove the LTTNG_UST_HOME environment variable before it is
added into an official release.

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
1479
1479
 
1480
1480
ENVIRONMENT VARIABLES
1481
1481
---------------------
1482
 
`LTTNG_UST_HOME`::
 
1482
`LTTNG_HOME`::
1483
1483
    Alternative user's home directory. This variable is useful when the
1484
1484
    user running the instrumented application has a non-writable home
1485
1485
    directory.
1486
1486
+
1487
1487
Unix sockets used for the communication between `liblttng-ust` and the
1488
1488
LTTng session and consumer daemons (part of the LTTng-tools project)
1489
 
are located in a specific directory under `$LTTNG_UST_HOME` (or `$HOME` if
1490
 
`$LTTNG_UST_HOME` is not set).
1491
 
 
1492
 
NOTE: `$LTTNG_HOME` is also supported as a fallback of `$LTTNG_UST_HOME` for
1493
 
backward compatibility reason.
 
1489
are located in a specific directory under `$LTTNG_HOME` (or `$HOME` if
 
1490
`$LTTNG_HOME` is not set).
1494
1491
 
1495
1492
`LTTNG_UST_ALLOW_BLOCKING`::
1496
1493
    If set, allow the application to retry event tracing when there's