[lttng-dev] [PATCH lttng-tools] Man: move [SESSION] before options

[Jérémie Galarneau]

Merged in master, stable-2.9 and stable-2.8.

Thanks!
Jérémie

On 13 January 2017 at 17:04, Jonathan Rajotte
<jonathan.rajotte-julien at efficios.com> wrote:
> The previous synopsis for the live mode can cause confusion to users
> since it can lead to an error while trying one of the simplest create
> command for live session that the synopsis is proposing:
>
> lttng create --live test.
>
> Other synopsis are modified for symmetry.
>
> Fixes #1081
>
> Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien at efficios.com>
> ---
>  doc/man/lttng-create.1.txt | 18 ++++++++----------
>  1 file changed, 8 insertions(+), 10 deletions(-)
>
> diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt
> index 8c61b09..152e3f3 100644
> --- a/doc/man/lttng-create.1.txt
> +++ b/doc/man/lttng-create.1.txt
> @@ -12,27 +12,25 @@ SYNOPSIS
>  Local mode:
>
>  [verse]
> -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* [option:--shm-path='PATH']
> -      [option:--no-output | option:--output='PATH' | option:--set-url=file://'PATH'] ['SESSION']
> +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* ['SESSION'] [option:--shm-path='PATH']
> +      [option:--no-output | option:--output='PATH' | option:--set-url=file://'PATH']
>
>  Network streaming mode:
>
>  [verse]
> -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* [option:--shm-path='PATH']
> -      (option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL') ['SESSION']
> -
> +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* ['SESSION'] [option:--shm-path='PATH']
> +      (option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL')
>  Snapshot mode:
>
>  [verse]
> -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--snapshot [option:--shm-path='PATH']
> -      [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] ['SESSION']
> +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* ['SESSION'] option:--snapshot
> +      [option:--shm-path='PATH'] [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL']
>
>  Live mode:
>
>  [verse]
> -*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* option:--live[='DELAYUS'] [option:--shm-path='PATH']
> -      [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL'] ['SESSION']
> -
> +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *create* ['SESSION'] option:--live[='DELAYUS']
> +      [option:--shm-path='PATH'] [option:--set-url='URL' | option:--ctrl-url='URL' option:--data-url='URL']
>
>  DESCRIPTION
>  -----------
> --
> 2.7.4
>



-- 
Jérémie Galarneau
EfficiOS Inc.
http://www.efficios.com