From: Pierre-Marc Fournier <pierre-marc.fournier@polymtl.ca>
Date: Thu, 25 Feb 2010 02:29:01 +0000 (-0500)
Subject: manual enhancements
X-Git-Tag: v1.9.1~710
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=70e55dbe90c621f2e77baf5f2b2a293b32aebb87;p=lttng-ust.git

manual enhancements
---

diff --git a/doc/manual/manual.texinfo b/doc/manual/manual.texinfo
index 702d0492..63b15090 100644
--- a/doc/manual/manual.texinfo
+++ b/doc/manual/manual.texinfo
@@ -54,10 +54,24 @@ This manual is for UST 0.1.
 @chapter Overview
 
 @menu
+* What is UST?::
 * License::
 * Supported platforms::
 @end menu
 
+@node What is UST?
+@section What is UST?
+
+The LTTng Userspace Tracer (UST) is a library accompanied by a set of tools to
+trace userspace code.
+
+Code may be instrumented with either markers or tracepoints. A highly efficient
+lockless tracer records these events to a trace buffers. These buffers are reaped
+by a deamon which writes trace data to disk.
+
+High performance is achieved by the use of lockless buffering algorithms, RCU and
+per-cpu buffers. In addition, special care is taken to minize cache impact.
+
 @node License
 @section License
 The LTTng Userspace Tracer is intended to be linkable to open source software
@@ -215,7 +229,7 @@ with the methods described in this chapter.
 @node Markers
 @section Markers
 
-Adding a marker is simply a matter of insert one line in the program.
+Adding a marker is simply a matter of inserting one line in the program.
 
 @example
 @verbatim
@@ -231,7 +245,7 @@ int main(int argc, char **argv)
 	/* a marker: */
 	trace_mark(main, myevent, "firstarg %d secondarg %s", v, st);
 
-	/* a marker without arguments: */
+	/* another marker without arguments: */
 	trace_mark(main, myotherevent, MARK_NOARGS);
 
 	return 0;