X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=contents%2Fpreface.md;h=1fedc25c0c82d3c91ac728b71892cf783d6f91d2;hb=85ccb28b9a18a29b9515e2d445185f8d0241c5f2;hp=35099daec5b9f5fcde37847e4d0fa5b6f7b13d31;hpb=638e28680ac0202b3ef16fcbce4cce5ab1d70b8c;p=lttng-docs.git diff --git a/contents/preface.md b/contents/preface.md index 35099da..1fedc25 100644 --- a/contents/preface.md +++ b/contents/preface.md @@ -70,9 +70,9 @@ time, some programming language skills. 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.