[lttng-dev] [PATCH lttng-tools] Add vpid, vppid and vtid explanation in add-context help menu

[David Goulet]

On 19 Jun (14:38:52), Francis Deslauriers wrote:
> On Thu, Jun 19, 2014 at 2:21 PM, David Goulet <dgoulet at efficios.com> wrote:
> > On 18 Jun (22:19:40), francis.deslauriers at efficios.com wrote:
> >> From: Francis Deslauriers <francis.deslauriers at efficios.com>
> >>
> >> Signed-off-by: Francis Deslauriers <francis.deslauriers at efficios.com>
> >> ---
> >>  src/bin/lttng/commands/add_context.c | 3 +++
> >>  1 file changed, 3 insertions(+)
> >>
> >> diff --git a/src/bin/lttng/commands/add_context.c b/src/bin/lttng/commands/add_context.c
> >> index 405b782..52d0db4 100644
> >> --- a/src/bin/lttng/commands/add_context.c
> >> +++ b/src/bin/lttng/commands/add_context.c
> >> @@ -514,6 +514,9 @@ static void usage(FILE *ofp)
> >>       fprintf(ofp, "                           TYPE can be one of the strings below:\n");
> >>       print_ctx_type(ofp);
> >>       fprintf(ofp, "\n");
> >> +     fprintf(ofp, "Note that the vpid, vppid and vtid context types represent the virtual process id,\n"
> >> +                     "virtual parent process id and virtual thread id as seen from the current execution context\n"
> >> +                     "as oppose to the pid, ppid and tid that are kernel internal data structures.\n\n");
> >
> > That would be kind of neat if you could also add this to the man page.
> > Usually, I try to keep both the --help and man page in sync :).
> 
> I didn't add it to the man page because there is no mention of the
> available context types in the man page.
> The user is asked to run the lttng add-context -h command to get more
> information on the available types.
> Should I add a note to the man page anyway?

Oh! Fair enough, that's all fine.

I'll merge this in a jiffy.

Thanks!
David

> 
> Thanks,
> Francis
> 
> >
> > Cheers!
> > David
> >
> >>       fprintf(ofp, "Example:\n");
> >>       fprintf(ofp, "This command will add the context information 'prio' and two per-cpu\n"
> >>                       "perf counters (hardware branch misses and cache misses), to all channels\n"
> >> --
> >> 1.8.3.2
> >>
> >>
> >> _______________________________________________
> >> 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/20140619/68199082/attachment.sig>