X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=contents%2Fpreface.md;h=1fedc25c0c82d3c91ac728b71892cf783d6f91d2;hb=3b5b45ec9eeae44744acb849c1a04eddd9d971c4;hp=d438b60b3e6f90e0353eb36f3e62297b1ae22cf6;hpb=727aa69028708972209886d7dd53b183c75903fe;p=lttng-docs.git diff --git a/contents/preface.md b/contents/preface.md index d438b60..1fedc25 100644 --- a/contents/preface.md +++ b/contents/preface.md @@ -63,16 +63,16 @@ try for students interested in the inner mechanics of their systems. Readers who do not have a programming background may wish to skip everything related to instrumentation, which requires, most of the -time, some C language skills. +time, some programming language skills.

Note to readers:This is an open documentation: its source is available in a public Git repository. Should you find any error in the contents of this text, -any grammatical mistake or any dead link, we would be very grateful if +any grammatical mistake, or any dead link, we would be very grateful if you would fill a GitHub issue for it or, even better, contribute a patch -to this documentation using a GitHub pull request.

+to this documentation by creating a pull request.

### Chapter descriptions @@ -90,7 +90,7 @@ as linear as possible. source. 3. [Getting started](#doc-getting-started) is a very concise guide to get started quickly with LTTng kernel and user space tracing. This - chapter is recommended if you're new to LTTng or software tracing + chapter is recommended if you're new to LTTng or to software tracing in general. 4. [Understanding LTTng](#doc-understanding-lttng) deals with some core concepts and components of the LTTng suite. Understanding @@ -99,15 +99,14 @@ as linear as possible. 5. [Using LTTng](#doc-using-lttng) is a complete user guide of the LTTng project. It shows in great details how to instrument user applications and the Linux kernel, how to control tracing sessions - using the `lttng` command line tool and miscellaneous practical use + using the `lttng` command line tool, and miscellaneous practical use cases. - 6. [Reference](#doc-reference) contains references of LTTng components, - like links to online manpages and various APIs. + 6. [Reference](#doc-reference) contains references of LTTng components. We recommend that you read the above chapters in this order, although some of them may be skipped depending on your situation. You may skip [Nuts and bolts](#doc-nuts-and-bolts) if you're familiar with tracing -and LTTng. Also, you may jump over +and the LTTng project. Also, you may jump over [Installing LTTng](#doc-installing-lttng) if LTTng is already properly installed on your target system.