From ba3b19940f99233f69286f343aaf47b0bb0cdb99 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Thu, 3 Sep 2015 23:38:42 -0400 Subject: [PATCH] Remove "etc." Signed-off-by: Philippe Proulx --- contents/getting-started/viewing-and-analyzing.md | 4 ++-- contents/nuts-and-bolts/what-is-tracing.md | 2 +- contents/reference/intro.md | 2 +- .../lttng-modules/lttng-modules-tp-struct-entry.md | 2 +- .../lttng-ust/liblttng-ust/liblttng-ust-tp-fields.md | 2 +- .../understanding-lttng/core-concepts/tracing-session.md | 4 ++-- contents/understanding-lttng/plumbing/lttng-sessiond.md | 6 +++--- contents/using-lttng/controlling-tracing/adding-context.md | 7 +++---- .../enabling-disabling-channels/intro.md | 6 +++--- .../controlling-tracing/enabling-disabling-events.md | 2 +- .../controlling-tracing/saving-loading-tracing-session.md | 5 +++-- contents/using-lttng/instrumenting/c-application/intro.md | 6 +++--- contents/using-lttng/intro.md | 5 +++-- 13 files changed, 27 insertions(+), 26 deletions(-) diff --git a/contents/getting-started/viewing-and-analyzing.md b/contents/getting-started/viewing-and-analyzing.md index 634f3d3..988ddec 100644 --- a/contents/getting-started/viewing-and-analyzing.md +++ b/contents/getting-started/viewing-and-analyzing.md @@ -143,8 +143,8 @@ python3 top5proc.py ~/lttng-sessions/my-session-.../kernel Make sure the path you provide is the directory containing actual trace -files (`channel0_0`, `metadata`, etc.): the `babeltrace` utility recurses -directories, but the Python binding does not. +files (`channel0_0`, `metadata`, and the rest): the `babeltrace` utility +recurses directories, but the Python binding does not. Here's an example of output: diff --git a/contents/nuts-and-bolts/what-is-tracing.md b/contents/nuts-and-bolts/what-is-tracing.md index e419a56..eabfd23 100644 --- a/contents/nuts-and-bolts/what-is-tracing.md +++ b/contents/nuts-and-bolts/what-is-tracing.md @@ -46,7 +46,7 @@ frequently than log messages, often in the thousands per second range, with very little execution overhead. Logging is more appropriate for very high-level analysis of less frequent events: user accesses, exceptional conditions (errors and warnings, for example), database -transactions, instant messaging communications, etc. More formally, +transactions, instant messaging communications, and such. More formally, logging is one of several use cases that can be accomplished with tracing. diff --git a/contents/reference/intro.md b/contents/reference/intro.md index 22d7901..19b67be 100644 --- a/contents/reference/intro.md +++ b/contents/reference/intro.md @@ -4,4 +4,4 @@ id: reference This chapter presents various references for LTTng packages such as links to online manpages, tables needed by the rest of the text, descriptions -of library functions, etc. +of library functions, and more. diff --git a/contents/reference/lttng-modules/lttng-modules-tp-struct-entry.md b/contents/reference/lttng-modules/lttng-modules-tp-struct-entry.md index ed475f8..5f90f47 100644 --- a/contents/reference/lttng-modules/lttng-modules-tp-struct-entry.md +++ b/contents/reference/lttng-modules/lttng-modules-tp-struct-entry.md @@ -26,7 +26,7 @@ of `LTTNG_TRACEPOINT_EVENT()`:
  • t integer C type (int, unsigned char, - size_t, etc.) + size_t, ...)
  • n field name
    • diff --git a/contents/reference/lttng-ust/liblttng-ust/liblttng-ust-tp-fields.md b/contents/reference/lttng-ust/liblttng-ust/liblttng-ust-tp-fields.md index 74ef490..76cbea0 100644 --- a/contents/reference/lttng-ust/liblttng-ust/liblttng-ust-tp-fields.md +++ b/contents/reference/lttng-ust/liblttng-ust/liblttng-ust-tp-fields.md @@ -27,7 +27,7 @@ within `TP_FIELDS()` in `TRACEPOINT_EVENT()`, are:
  • t integer C type (int, long, - size_t, etc.) + size_t, ...)
  • n field name
  • e argument expression
    • diff --git a/contents/understanding-lttng/core-concepts/tracing-session.md b/contents/understanding-lttng/core-concepts/tracing-session.md index 3b0e40a..1a70b10 100644 --- a/contents/understanding-lttng/core-concepts/tracing-session.md +++ b/contents/understanding-lttng/core-concepts/tracing-session.md @@ -23,13 +23,13 @@ which are described in the following sections): * a name * the channel state (enabled or disabled) * its parameters (event loss mode, sub-buffers size and count, - timer periods, output type, trace files size and count, etc.) + timer periods, output type, trace files size and count, and the rest) * a list of added context information * a list of [events](#doc-event) * for each event: * its state (enabled or disabled) * a list of instrumentation points (tracepoints, system calls, - dynamic probes, etc.) + dynamic probes, other types of probes) * associated log levels * a filter expression diff --git a/contents/understanding-lttng/plumbing/lttng-sessiond.md b/contents/understanding-lttng/plumbing/lttng-sessiond.md index 6e298e4..f87beaa 100644 --- a/contents/understanding-lttng/plumbing/lttng-sessiond.md +++ b/contents/understanding-lttng/plumbing/lttng-sessiond.md @@ -7,8 +7,8 @@ by its command name, `lttng-sessiond`. The session daemon is responsible for managing tracing sessions and what they logically contain (channel properties, enabled/disabled -events, etc.). By communicating locally with instrumented applications -(using LTTng-UST) and with the LTTng Linux kernel modules +events, and the rest). By communicating locally with instrumented +applications (using LTTng-UST) and with the LTTng Linux kernel modules (LTTng-modules), it oversees all tracing activities. One of the many things that `lttng-sessiond` does is to keep @@ -24,7 +24,7 @@ and user space tracers, the session daemon can send channel information so that they are initialized, enable/disable specific probes based on enabled/disabled events by the user, send event filters information to LTTng tracers so that filtering actually happens at the tracer site, -start/stop tracing a specific application or the Linux kernel, etc. +start/stop tracing a specific application or the Linux kernel, and more. The session daemon is not useful without some user controlling it, because it's only a sophisticated control interchange and thus diff --git a/contents/using-lttng/controlling-tracing/adding-context.md b/contents/using-lttng/controlling-tracing/adding-context.md index c77f1d5..34ab0f7 100644 --- a/contents/using-lttng/controlling-tracing/adding-context.md +++ b/contents/using-lttng/controlling-tracing/adding-context.md @@ -21,12 +21,11 @@ recorded by LTTng, for example: * scheduling priority (niceness) * thread identifier (TID) * the **hostname** of the system on which the event occurred - * plenty of **performance counters** using perf: - * CPU cycles, stalled cycles, idle cycles, etc. + * plenty of **performance counters** using perf, for example: + * CPU cycles, stalled cycles, idle cycles, and the other cycle types * cache misses - * branch instructions, misses, loads, etc. + * branch instructions, misses, loads * CPU faults - * etc. The full list is available in the output of `lttng add-context --help`. Some of them are reserved for a specific domain (kernel or diff --git a/contents/using-lttng/controlling-tracing/enabling-disabling-channels/intro.md b/contents/using-lttng/controlling-tracing/enabling-disabling-channels/intro.md index 062c182..676d4ba 100644 --- a/contents/using-lttng/controlling-tracing/enabling-disabling-channels/intro.md +++ b/contents/using-lttng/controlling-tracing/enabling-disabling-channels/intro.md @@ -7,9 +7,9 @@ id: enabling-disabling-channels events are contained in a specific channel, itself contained in a specific tracing session. A channel is a group of events with tunable parameters (event loss mode, sub-buffer size, number of -sub-buffers, trace file sizes and count, etc.). A given channel may -only be responsible for enabled events belonging to one domain: either -kernel or user space. +sub-buffers, trace file sizes and count, to name a few). A given channel +may only be responsible for enabled events belonging to one domain: +either kernel or user space. If you only used the `create`, `enable-event` and `start`/`stop` commands of the `lttng` tool so far, one or two channels were diff --git a/contents/using-lttng/controlling-tracing/enabling-disabling-events.md b/contents/using-lttng/controlling-tracing/enabling-disabling-events.md index e41a933..26ab44e 100644 --- a/contents/using-lttng/controlling-tracing/enabling-disabling-events.md +++ b/contents/using-lttng/controlling-tracing/enabling-disabling-events.md @@ -16,7 +16,7 @@ composed of: (required). 2. One or many **instrumentation points** in source code or binary program (tracepoint name, address, symbol name, function name, - logger name, etc.) to be executed (required). + logger name, amongst other types of probes) to be executed (required). 3. A **log level** (each instrumentation point declares its own log level) or log level range to match (optional; only valid for user space domain). diff --git a/contents/using-lttng/controlling-tracing/saving-loading-tracing-session.md b/contents/using-lttng/controlling-tracing/saving-loading-tracing-session.md index e6a6714..08b2f3f 100644 --- a/contents/using-lttng/controlling-tracing/saving-loading-tracing-session.md +++ b/contents/using-lttng/controlling-tracing/saving-loading-tracing-session.md @@ -4,8 +4,9 @@ id: saving-loading-tracing-session Configuring a tracing session may be long: creating and enabling channels with specific parameters, enabling kernel and user space -domain events with specific log levels and filters, adding context -to some channels, etc. If you're going to use LTTng to solve real +domain events with specific log levels and filters, and adding context +to some channels are just a few of the many possible operations using +the `lttng` command line tool. If you're going to use LTTng to solve real world problems, chances are you're going to have to record events using the same tracing session setup over and over, modifying a few variables each time in your instrumented program or environment. To avoid diff --git a/contents/using-lttng/instrumenting/c-application/intro.md b/contents/using-lttng/instrumenting/c-application/intro.md index ffafac9..24858ce 100644 --- a/contents/using-lttng/instrumenting/c-application/intro.md +++ b/contents/using-lttng/instrumenting/c-application/intro.md @@ -10,9 +10,9 @@ LTTng-UST package includes a dynamically loaded library Since C and C++ are the base languages of virtually all other programming languages -(Java virtual machine, Python, Perl, PHP and Node.js interpreters, etc.), -implementing user space tracing for an unsupported language is just a -matter of using the LTTng-UST C API at the right places. +(Java virtual machine, Python, Perl, PHP and Node.js interpreters, to +name a few), implementing user space tracing for an unsupported language +is just a matter of using the LTTng-UST C API at the right places. The usual work flow to instrument a user space C application with LTTng-UST is: diff --git a/contents/using-lttng/intro.md b/contents/using-lttng/intro.md index 0590913..48a6e69 100644 --- a/contents/using-lttng/intro.md +++ b/contents/using-lttng/intro.md @@ -9,7 +9,7 @@ _[Instrumenting](#doc-instrumenting)_ is the process of inserting probes into some source code. It can be done manually, by writing tracepoint calls at specific locations in the source code of the program to trace, or more automatically using dynamic probes (address in assembled code, -symbol name, function entry/return, etc.). +symbol name, function entry/return, and others). It has to be noted that, as an LTTng user, you may not have to worry about the instrumentation process. Indeed, you may want to trace a @@ -21,7 +21,8 @@ _[Controlling tracing](#doc-controlling-tracing)_ is everything that can be done by the LTTng session daemon, which is controlled using `liblttng-ctl` or its command line utility, `lttng`: creating tracing sessions, listing tracing sessions and events, enabling/disabling -events, starting/stopping the tracers, taking snapshots, etc. +events, starting/stopping the tracers, taking snapshots, amongst many +other commands. This chapter is a complete user guide of both activities, with common use cases of LTTng exposed throughout the text. It is -- 2.34.1