From f762992f6da9322f6e37f9c6fa9e7ef4f6dd2439 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Wed, 15 Mar 2017 13:00:05 -0400 Subject: [PATCH] welcome: reword a part Signed-off-by: Philippe Proulx --- 2.5/lttng-docs-2.5.txt | 32 +++++++++++++++++++++++++++++++- 2.6/lttng-docs-2.6.txt | 32 +++++++++++++++++++++++++++++++- common/welcome.txt | 22 +++++++++++++++------- 3 files changed, 77 insertions(+), 9 deletions(-) diff --git a/2.5/lttng-docs-2.5.txt b/2.5/lttng-docs-2.5.txt index ad6213d..821afd0 100644 --- a/2.5/lttng-docs-2.5.txt +++ b/2.5/lttng-docs-2.5.txt @@ -10,7 +10,37 @@ include::../common/copyright.txt[] include::../common/warning-not-maintained.txt[] -include::../common/welcome.txt[] +[[welcome]] +== Welcome! + +Welcome to the **LTTng Documentation**! + +The _Linux Trace Toolkit: next generation_ is an open source software +toolkit which you can use to simultaneously trace the Linux kernel, user +applications, and user libraries. + +LTTng consists of: + +* Kernel modules to trace the Linux kernel. +* Shared libraries to trace user applications written in C or C++. +* Java packages to trace Java applications which use + `java.util.logging`. +* A kernel module to trace shell scripts and other user applications + without a dedicated instrumentation mechanism. +* Daemons and a command-line tool, cmd:lttng, to control the + LTTng tracers. + +[NOTE] +.Open source documentation +==== +This is an **open documentation**: its source is available in a +https://github.com/lttng/lttng-docs[public Git repository]. + +Should you find any error in the content of this text, any grammatical +mistake, or any dead link, we would be very grateful if you would file a +GitHub issue for it or, even better, contribute a patch to this +documentation by creating a pull request. +==== include::../common/audience.txt[] diff --git a/2.6/lttng-docs-2.6.txt b/2.6/lttng-docs-2.6.txt index c579228..e302524 100644 --- a/2.6/lttng-docs-2.6.txt +++ b/2.6/lttng-docs-2.6.txt @@ -10,7 +10,37 @@ include::../common/copyright.txt[] include::../common/warning-not-maintained.txt[] -include::../common/welcome.txt[] +[[welcome]] +== Welcome! + +Welcome to the **LTTng Documentation**! + +The _Linux Trace Toolkit: next generation_ is an open source software +toolkit which you can use to simultaneously trace the Linux kernel, user +applications, and user libraries. + +LTTng consists of: + +* Kernel modules to trace the Linux kernel. +* Shared libraries to trace user applications written in C or C++. +* Java packages to trace Java applications which use `java.util.logging` + or Apache log4j 1.2. +* A kernel module to trace shell scripts and other user applications + without a dedicated instrumentation mechanism. +* Daemons and a command-line tool, cmd:lttng, to control the + LTTng tracers. + +[NOTE] +.Open source documentation +==== +This is an **open documentation**: its source is available in a +https://github.com/lttng/lttng-docs[public Git repository]. + +Should you find any error in the content of this text, any grammatical +mistake, or any dead link, we would be very grateful if you would file a +GitHub issue for it or, even better, contribute a patch to this +documentation by creating a pull request. +==== include::../common/audience.txt[] diff --git a/common/welcome.txt b/common/welcome.txt index 782027e..ac73634 100644 --- a/common/welcome.txt +++ b/common/welcome.txt @@ -4,13 +4,21 @@ Welcome to the **LTTng Documentation**! The _Linux Trace Toolkit: next generation_ is an open source software -toolkit used to simultaneously trace the Linux kernel, user applications, -and user libraries. LTTng consists of <> -(for Linux kernel tracing) and dynamically loaded -<> (for user application and library tracing). -A <> controls the LTTng tracers after it -receives commands from the <>. +toolkit which you can use to simultaneously trace the Linux kernel, user +applications, and user libraries. + +LTTng consists of: + +* Kernel modules to trace the Linux kernel. +* Shared libraries to trace user applications written in C or C++. +* Java packages to trace Java applications which use `java.util.logging` + or Apache log4j 1.2. +* A Python package to trace Python applications which use the standard + `logging` package. +* A kernel module to trace shell scripts and other user applications + without a dedicated instrumentation mechanism. +* Daemons and a command-line tool, cmd:lttng, to control the + LTTng tracers. [NOTE] .Open source documentation -- 2.34.1