From: Philippe Proulx Date: Fri, 4 Sep 2015 01:49:31 +0000 (-0400) Subject: Remove unneeded "will"s + minor fixes X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=47bfcb757a0192864b56d12d775f65dc8b180aaf;p=lttng-docs.git Remove unneeded "will"s + minor fixes Signed-off-by: Philippe Proulx --- diff --git a/contents/getting-started/intro.md b/contents/getting-started/intro.md index 26b69d1..acd95ee 100644 --- a/contents/getting-started/intro.md +++ b/contents/getting-started/intro.md @@ -8,11 +8,12 @@ thorough understanding of LTTng, see [Using LTTng](#doc-using-lttng) and [Understanding LTTng](#doc-understanding-lttng). Before reading this guide, make sure LTTng -[is installed](#doc-installing-lttng). You will at least need -LTTng-tools. Also install LTTng-modules for +[is installed](#doc-installing-lttng). You need LTTng-tools. Also install +LTTng-modules for [tracing the Linux kernel](#doc-tracing-the-linux-kernel) and LTTng-UST for [tracing your own user space applications](#doc-tracing-your-own-user-application). When your traces are finally written and complete, the [Viewing and analyzing your traces](#doc-viewing-and-analyzing-your-traces) -section of this chapter will help you analyze your tracepoint events to investigate. +section of this chapter will help you analyze your tracepoint events +to investigate. diff --git a/contents/getting-started/tracing-the-linux-kernel.md b/contents/getting-started/tracing-the-linux-kernel.md index 2a5eb74..c7522e2 100644 --- a/contents/getting-started/tracing-the-linux-kernel.md +++ b/contents/getting-started/tracing-the-linux-kernel.md @@ -29,7 +29,7 @@ sudo lttng create my-session `my-session` is the tracing session name and could be anything you -like. `auto` will be used if omitted. +like. `auto` is used if omitted. Let's now enable some events for this session: @@ -38,7 +38,7 @@ sudo lttng enable-event --kernel sched_switch,sched_process_fork or you might want to simply enable all available kernel events (beware -that trace files will grow rapidly when doing this): +that trace files grow rapidly when doing this): 
 sudo lttng enable-event --kernel --all
diff --git a/contents/getting-started/tracing-your-own-user-application.md b/contents/getting-started/tracing-your-own-user-application.md
index a071203..71ac5e8 100644
--- a/contents/getting-started/tracing-your-own-user-application.md
+++ b/contents/getting-started/tracing-your-own-user-application.md
@@ -19,7 +19,7 @@ know the types of its arguments: the formats of all tracepoints must be
 defined before using them. So before even writing our _Hello world_ program,
 we need to define the format of our tracepoint. This is done by writing a
 **template file**, with a name usually ending with the `.tp` extension (for **t**race**p**oint),
-which the `lttng-gen-tp` tool (shipped with LTTng-UST) will use to generate
+which the `lttng-gen-tp` tool (shipped with LTTng-UST) uses to generate
 an object file (along with a `.c` file) and a header to be included in our application source code.
 
 Here's the whole flow:
@@ -31,7 +31,7 @@ Here's the whole flow:
 
 
 The template file format is a list of tracepoint definitions
-and other optional definition entries which we will skip for
+and other optional definition entries which we skip for
 this quickstart. Each tracepoint is defined using the
 `TRACEPOINT_EVENT()` macro. For each tracepoint, you must provide:
 
@@ -41,8 +41,8 @@ this quickstart. Each tracepoint is defined using the
   * a **list of arguments** for the eventual `tracepoint()` call, each item being:
     * the argument C type
     * the argument name
-  * a **list of fields**, which will be the actual fields of the recorded events
-    for this tracepoint
+  * a **list of fields**, which correspond to the actual fields of the
+    recorded events for this tracepoint
 
 Here's a simple tracepoint definition example with two arguments: an integer
 and a string:
@@ -73,7 +73,7 @@ Save the above snippet as `hello-tp.tp` and run:
 lttng-gen-tp hello-tp.tp
-The following files will be created next to `hello-tp.tp`: +The following files are created next to `hello-tp.tp`: * `hello-tp.c` * `hello-tp.o` @@ -139,7 +139,7 @@ gcc -o hello hello.c hello-tp.o -llttng-ust -ldl If you followed the [Tracing the Linux kernel](#doc-tracing-the-linux-kernel) section, the -following steps will look familiar. +following steps should look familiar. First, run the application with a few arguments: @@ -182,7 +182,7 @@ lttng start Go back to the running `hello` application and press Enter. All `tracepoint()` -calls will be executed and the program will finally exit. +calls are executed and the program finally exits. Stop tracing: diff --git a/contents/getting-started/viewing-and-analyzing.md b/contents/getting-started/viewing-and-analyzing.md index 5485093..634f3d3 100644 --- a/contents/getting-started/viewing-and-analyzing.md +++ b/contents/getting-started/viewing-and-analyzing.md @@ -33,8 +33,8 @@ path to `babeltrace` with no options: babeltrace ~/lttng-traces/my-session -`babeltrace` will find all traces within the given path recursively and -output all their events, merging them intelligently. +`babeltrace` finds all traces within the given path recursively and +prints all their events, merging them in order of time. Listing all the system calls of a Linux kernel trace with their arguments is easy with `babeltrace` and `grep`: diff --git a/contents/installing-lttng/building-from-source.md b/contents/installing-lttng/building-from-source.md index 79f294f..580ebd1 100644 --- a/contents/installing-lttng/building-from-source.md +++ b/contents/installing-lttng/building-from-source.md @@ -24,9 +24,9 @@ are rendered as rich text when If you're using Ubuntu, executing the following Bash script -will install the appropriate dependencies, clone the LTTng -Git repositories, build the projects, and install them. The sources will -be cloned into `~/src`. Your user needs to be a sudoer for the install +installs the appropriate dependencies, clone the LTTng +Git repositories, build the projects, and install them. The sources +are cloned into `~/src`. Your user needs to be a sudoer for the install steps to be completed. ~~~ text diff --git a/contents/installing-lttng/desktop-distributions/debian.md b/contents/installing-lttng/desktop-distributions/debian.md index 2776a8e..fee248f 100644 --- a/contents/installing-lttng/desktop-distributions/debian.md +++ b/contents/installing-lttng/desktop-distributions/debian.md @@ -2,7 +2,7 @@ id: debian --- -Debian wheezy (stable) and previous versions are not supported; you will +Debian wheezy (stable) and previous versions are not supported; you need to build and install LTTng packages [from source](#doc-building-from-source) for those. diff --git a/contents/installing-lttng/desktop-distributions/opensuse.md b/contents/installing-lttng/desktop-distributions/opensuse.md index b1d0f99..57c0d9f 100644 --- a/contents/installing-lttng/desktop-distributions/opensuse.md +++ b/contents/installing-lttng/desktop-distributions/opensuse.md @@ -6,7 +6,7 @@ openSUSE has had LTTng packages since version 12.3. To install LTTng, you first need to add an entry to your repository configuration. All LTTng repositories are available here. -For example, the following commands will add the LTTng repository for +For example, the following commands adds the LTTng repository for openSUSE 13.1: 
diff --git a/contents/installing-lttng/desktop-distributions/ubuntu/intro.md b/contents/installing-lttng/desktop-distributions/ubuntu/intro.md
index ab0c14f..57f97c0 100644
--- a/contents/installing-lttng/desktop-distributions/ubuntu/intro.md
+++ b/contents/installing-lttng/desktop-distributions/ubuntu/intro.md
@@ -3,7 +3,7 @@ id: ubuntu
 ---
 
 The following steps apply to Ubuntu ≥ 12.04. For
-previous releases, you will need to build and install LTTng
+previous releases, you need to build and install LTTng
 [from source](#doc-building-from-source), as no Ubuntu packages were
 available before version 12.04.
 
diff --git a/contents/understanding-lttng/core-concepts/channel/channel-buffering-schemes.md b/contents/understanding-lttng/core-concepts/channel/channel-buffering-schemes.md
index 3b0c610..e6b87d0 100644
--- a/contents/understanding-lttng/core-concepts/channel/channel-buffering-schemes.md
+++ b/contents/understanding-lttng/core-concepts/channel/channel-buffering-schemes.md
@@ -9,7 +9,7 @@ available when creating a channel:
   * **Per-UID buffering**: keep one ring buffer for all processes of
     a single user.
 
-The per-PID buffering scheme will consume more memory than the per-UID
+The per-PID buffering scheme consumes more memory than the per-UID
 option if more than one process is instrumented for LTTng-UST. However,
 per-PID buffering ensures that one process having a high event
 throughput won't fill all the shared sub-buffers, only its own.
diff --git a/contents/understanding-lttng/core-concepts/channel/channel-overwrite-mode-vs-discard-mode.md b/contents/understanding-lttng/core-concepts/channel/channel-overwrite-mode-vs-discard-mode.md
index 2879bf2..53d799b 100644
--- a/contents/understanding-lttng/core-concepts/channel/channel-overwrite-mode-vs-discard-mode.md
+++ b/contents/understanding-lttng/core-concepts/channel/channel-overwrite-mode-vs-discard-mode.md
@@ -9,7 +9,7 @@ As events occur, they are serialized as trace data into a specific
 sub-buffer (yellow arc in the following animation) until it is full:
 when this happens, the sub-buffer is marked as consumable (red) and
 another, _empty_ (white) sub-buffer starts receiving the following
-events. The marked sub-buffer will be consumed eventually by a consumer
+events. The marked sub-buffer is eventually consumed by a consumer
 daemon (returns to white).