X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;ds=sidebyside;f=2.5%2Flttng-docs-2.5.txt;h=821afd097750d6d783ed0938f4f625a826f798c4;hb=f762992f6da9322f6e37f9c6fa9e7ef4f6dd2439;hp=9e08004bea0b55a2ba53716f3fccb6838d6bfc81;hpb=f0287ae19ba24983cb17b0614879195ffd051e77;p=lttng-docs.git diff --git a/2.5/lttng-docs-2.5.txt b/2.5/lttng-docs-2.5.txt index 9e08004..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[] @@ -193,6 +223,8 @@ and viewed once tracing is inactive or in real-time. [[installing-lttng]] == Installing LTTng +include::../common/warning-installation-outdated.txt[] + **LTTng** is a set of software components which interact to allow instrumenting the Linux kernel and user applications and controlling tracing sessions (starting/stopping tracing, enabling/disabling events,