[lttng-dev] [PATCH lttng-ust 1/2] Doc: add LTTNG_UST_GETCPU_PLUGIN to man page

[lttng-dev] [PATCH lttng-ust 1/2] Doc: add LTTNG_UST_GETCPU_PLUGIN to man page

[Jonathan Rajotte]

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien at efficios.com>
---
 doc/man/lttng-ust.3 | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index 15b4989..829f7ae 100644
--- a/doc/man/lttng-ust.3
+++ b/doc/man/lttng-ust.3
@@ -497,6 +497,11 @@ startup time.
 .IP "LTTNG_UST_WITHOUT_BADDR_STATEDUMP"
 Prevent liblttng-ust to perform a base-address statedump on session-enable.
 .PP
+.IP "LTTNG_UST_GETCPU_PLUGIN"
+Used by the getcpu override plugin system. The environment variable is used to
+provide the path of the shared object who will act as the getcpu override
+plugin. Example can be found under doc/example/getcpu-override .
+.PP
 
 .SH "SEE ALSO"
 
-- 
2.1.4

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

[Jonathan Rajotte]

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..e6c0c80 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 clock
+definition and functions. Thus LTTNG_UST_CLOCK_PLUGIN need to be define when
+launching lttng-sessiond.
diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index 829f7ae..e16efea 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 is used to
 provide the path of the shared object who will act as the getcpu override
 plugin. Example can be found under doc/example/getcpu-override .
 .PP
+.IP "LTTNG_UST_CLOCK_PLUGIN"
+Used by the clock override plugin system. The environment variable is used to
+provide the path of the shared object who will act as the clock override
+plugin. Example can be found under doc/example/clock-override .
+.PP
 
 .SH "SEE ALSO"
 
-- 
2.1.4

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

[Antoine Busque]

On Thu, Jul 23, 2015 at 1:59 PM, Jonathan Rajotte
<jonathan.rajotte-julien at efficios.com> wrote:
> +When using LTTng-tools keep in mind that lttng-sessiond uses lttng-ust clock

Maybe change to "uses lttng-ust's"

> +definition and functions. Thus LTTNG_UST_CLOCK_PLUGIN need to be define when

"needs to be defined"

> +.IP "LTTNG_UST_CLOCK_PLUGIN"
> +Used by the clock override plugin system. The environment variable is used to
> +provide the path of the shared object who will act as the clock override
> +plugin. Example can be found under doc/example/clock-override .

As per comments on previous patch, "path to", "which will", "An example" or
"Examples" and "doc/examples/" in the path.

Regards,
Antoine Busque.

[lttng-dev] [PATCH lttng-ust 1/2] Doc: add LTTNG_UST_GETCPU_PLUGIN to man page

[Antoine Busque]

On Thu, Jul 23, 2015 at 1:59 PM, Jonathan Rajotte
<jonathan.rajotte-julien at efficios.com> wrote:
> +provide the path of the shared object who will act as the getcpu override

 I'd phrase this as "provide the path to", and "which will act".

> +plugin. Example can be found under doc/example/getcpu-override .

"Examples" or "An Example", also the path should be
"doc/examples/getcpu-override".

Regards,
Antoine Busque

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

[Jonathan Rajotte]

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien at efficios.com>
---
 doc/man/lttng-ust.3 | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index 15b4989..e66ab88 100644
--- a/doc/man/lttng-ust.3
+++ b/doc/man/lttng-ust.3
@@ -497,6 +497,11 @@ startup time.
 .IP "LTTNG_UST_WITHOUT_BADDR_STATEDUMP"
 Prevent liblttng-ust to perform a base-address statedump on session-enable.
 .PP
+.IP "LTTNG_UST_GETCPU_PLUGIN"
+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
 
 .SH "SEE ALSO"
 
-- 
2.1.4

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

[Jonathan Rajotte]

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

[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