[lttng-dev] [PATCH lttng-tool] mi: add machine interface description to man page

[David Goulet]

Merged. I corrected a couple of things but most of it is there.

Thanks!
David

On 29 Jul (10:25:52), Jonathan Rajotte Julien wrote:
> Signed-off-by: Jonathan Rajotte Julien <jonathan.r.julien at gmail.com>
> ---
>  doc/man/lttng.1 | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
> 
> diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
> index 12ca33d..de13b76 100644
> --- a/doc/man/lttng.1
> +++ b/doc/man/lttng.1
> @@ -77,6 +77,26 @@ Simple listing of lttng options.
>  .TP
>  .BR "\-\-list\-commands"
>  Simple listing of lttng commands.
> +.TP
> +.BR "\-m, \-\-mi TYPE
> +Machine interface
> +
> +TYPE supported: XML
> +
> +Machine interface (MI) mode convert the traditional pretty printing to a more
> +machine friendly output syntax. Mi mode provide a format change-resistant way to
> +access information generated via lttng-cli.
> +
> +When using MI mode, the generated document is outputted on STDOUT.
> +Errors and warning are outputted as normal on STDERR and in normal format.
> +
> +If any errors occurs during the execution of a command, the return value
> +of the command will be different than zero as normal. In this event, lttng does
> +no guarantees the syntax and data validity of the generated document.
> +
> +For XML output type, lttng provide an xml schema definitioni (XSD) file for validation. It
> +can be found under: lttng-tools/src/common/mi_lttng.xsd.
> +
>  .SH "COMMANDS"
>  
>  .PP
> -- 
> 2.0.0
> 
> 
> _______________________________________________
> lttng-dev mailing list
> lttng-dev at lists.lttng.org
> http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 603 bytes
Desc: Digital signature
URL: <http://lists.lttng.org/pipermail/lttng-dev/attachments/20140729/a42211ba/attachment.sig>