[lttng-dev] [PATCH v2 lttng-ust 2/2] Doc: add LTTNG_UST_CLOCK_PLUGIN to man page

[Mathieu Desnoyers]

Merged those 2 patches, with a small modification:

"An example can be found in the lttng-ust documentation under
examples/getcpu-override ."

and

"An example can be found in the lttng-ust documentation under
doc/examples/clock-override ."

Otherwise we end up with an installed manpage that points to
subdirectories within the source tree, which is weird. The
examples files are installed too (see e.g.
/usr/local/share/doc/lttng-ust/examples/).

Thanks,

Mathieu

----- On Jul 23, 2015, at 4:02 PM, Jonathan Rajotte jonathan.rajotte-julien at efficios.com wrote:

> Also add indications on how to use the plugin with lttng-tools.
> 
> Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien at efficios.com>
> ---
> doc/examples/clock-override/README | 4 ++++
> doc/man/lttng-ust.3                | 5 +++++
> 2 files changed, 9 insertions(+)
> 
> diff --git a/doc/examples/clock-override/README
> b/doc/examples/clock-override/README
> index e3ddf22..aabbee2 100644
> --- a/doc/examples/clock-override/README
> +++ b/doc/examples/clock-override/README
> @@ -2,3 +2,7 @@ This clock override example shows how to implement and load a
> clock
> override plugin for LTTng-UST. This can be useful in cases where direct
> hardware access is available for architecture-specific clocks, and where
> it should be used rather than the Linux kernel Monotonic clock.
> +
> +When using LTTng-tools keep in mind that lttng-sessiond uses lttng-ust's clock
> +definition and functions. Thus LTTNG_UST_CLOCK_PLUGIN needs to be defined when
> +launching lttng-sessiond.
> diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
> index e66ab88..8b399aa 100644
> --- a/doc/man/lttng-ust.3
> +++ b/doc/man/lttng-ust.3
> @@ -502,6 +502,11 @@ Used by the getcpu override plugin system. The environment
> variable
> provides the path to the shared object which will act as the getcpu override
> plugin. An example can be found under doc/examples/getcpu-override .
> .PP
> +.IP "LTTNG_UST_CLOCK_PLUGIN"
> +Used by the clock override plugin system. The environment variable
> +provides the path to the shared object wich will act as the clock override
> +plugin. An example can be found under doc/examples/clock-override .
> +.PP
> 
> .SH "SEE ALSO"
> 
> --
> 2.1.4

-- 
Mathieu Desnoyers
EfficiOS Inc.
http://www.efficios.com