welcome: reword a part

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/2.5/lttng-docs-2.5.txt b/2.5/lttng-docs-2.5.txt
index ad6213d42dc675eb8bda46bbed9c990f32efdee7..821afd097750d6d783ed0938f4f625a826f798c4 100644 (file)
--- 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 c57922865567e9d3f37cce292d3475e99e98a358..e302524096e3e1a63c7a19cdabf5bd1732415477 100644 (file)
--- 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 782027e3a75293e51b7ccb474889036647f7a4a7..ac73634548db7ff294787f62fc38952437f8a59b 100644 (file)
--- 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 <<lttng-modules,kernel modules>>
-(for Linux kernel tracing) and dynamically loaded
-<<lttng-ust,libraries>> (for user application and library tracing).
-A <<lttng-sessiond,session daemon>> controls the LTTng tracers after it
-receives commands from the <<lttng-cli,cmd:lttng command-line
-tool>>.
+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