[lttng-dev] Minor documentation issue with 2.4.0

[Jérémie Galarneau]

Hi Amit,

Can you open a bug against lttng-tools on bugs.lttng.org? This way
we'll be sure to track the change.

Thanks,
Jérémie

On Wed, Apr 2, 2014 at 5:23 AM, Amit Margalit <AMITM at il.ibm.com> wrote:
> Hello,
>
> I ran a command that included an error, and noticed that 'lttng' mentions -j
> in --buffers-pid and --buffers-uid, but nowhere else:
>
> # /usr/bin/lttng enable-channel -u
> Error: Missing channel name.
>
> usage: lttng enable-channel NAME[,NAME2,...] (-u | -k) [OPTIONS]
>
> Options:
>   -h, --help               Show this help
>       --list-options       Simple listing of options
>   -s, --session NAME       Apply to session name
>   -k, --kernel             Apply to the kernel tracer
>   -u, --userspace          Apply to the user-space tracer
>
> Channel options:
>       --discard            Discard event when buffers are full (default)
>       --overwrite          Flight recorder mode
>       --subbuf-size SIZE   Subbuffer size in bytes {+k,+M,+G}
>                                (default UST uid: 131072, UST pid: 4096,
> kernel: 262144, metadata: 4096)
>                                Rounded up to the next power of 2.
>       --num-subbuf NUM     Number of subbufers
>                                (default UST uid: 4, UST pid: 4, kernel: 4,
> metadata: 2)
>                                Rounded up to the next power of 2.
>       --switch-timer USEC  Switch timer interval in usec
>                                (default UST uid: 0, UST pid: 0, kernel: 0,
> metadata: 0)
>       --read-timer USEC    Read timer interval in usec.
>                                (default UST uid: 0, UST pid: 0, kernel:
> 200000, metadata: 0)
>       --output TYPE        Channel output type (Values: mmap, splice)
>                                (default UST uid: mmap, UST pid: mmap,
> kernel: splice, metadata: mmap)
>       --buffers-uid        Use per UID buffer (-u/-j only)
>       --buffers-pid        Use per PID buffer (-u/-j only)
>       --buffers-global     Use shared buffer for the whole system (-k only)
>   -C, --tracefile-size SIZE
>                            Maximum size of each tracefile within a stream
> (in bytes). 0 means unlimited.
>                                (default: 0)
>   -W, --tracefile-count COUNT
>                            Used in conjunction with -C option, this will
> limit the number
>                            of files created to the specified count. 0 means
> unlimited.
>                                (default: 0)
>
> Error: Command error
>
> You can see these 2 lines:
>
>       --buffers-uid        Use per UID buffer (-u/-j only)
>       --buffers-pid        Use per PID buffer (-u/-j only)
>
> But -j is not explained above.
>
> Amit Margalit
> IBM XIV - Storage Reinvented
> XIV-NAS Development Team
> Tel. 03-689-7774
> Fax. 03-689-7230
> _______________________________________________
> lttng-dev mailing list
> lttng-dev at lists.lttng.org
> http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev
>



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