lttng/lttng-docs — pull request #3 by sebhtml (2014-10-19 18:24:16+00:00)
Title: Changes 2014 10 19

Hi,

I am a LTTng-UST end user. I also use babeltrace.
Regarding the documentation: 10/10, would read it again.

In particular, your documentation team should be praised for the section
"Tracing your own user application" which is self-contained and sufficient for
getting started with -UST.

Here are some suggestions for the documentation at http://lttng.org/docs.
I provide my changes as a pull request (each change is in its own commit so that
each change can be accepted / refused independently).

- In http://lttng.org/docs/#doc-tracing-your-own-user-application, 'lttng view' is called after 'lttng destroy', which means
that lttng view won't work.

- The home page (lttng.org) as a nice 3-step introduction to tracing: 1. Instrument, 2. Trace, 3. Investigate.
These 3 steps were for me the reason why I decided to use LTTng: I could understand the big picture just from these
3 items.
I think these 3 steps should be included early in the documentation (probably near "what is tracing like I am five).

- *Big picture* for average Joe:
it should be mentionned that LTTng-{tools,modules,UST} are used in steps "1. Instrument" and in step
"2. Trace" whereas babeltrace CLI, babeltrace
Python binding, and Eclipse Trace Compass are used in step "3. Investigate".

- Are server distributions (like CentOS) considered a Desktop or enterprise distribution ?

- Enterprise distributions should be moved outside the Desktop distribution heading.

- I think there is a difference between tracing "your own userspace applications" and "tracing
userspace applications". "your own" is a specific case of the other, and -UST address the general case
(and hence the specific case).

- "userspace" vs "user-space" vs "user space": be consistent and pick up one (Wikipedia uses "user space")
I did not change this since I don't know which one the LTTng team has elected to use throughout.

- Some guidelines for naming tracepoint names would be welcomed.