X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=README.md;h=66bf925394dfe099c9ee185bb8664ee742f25996;hb=59a49244b2cd0e06b15457a570ea7c5b3f0a5a53;hp=f87b47bc468a24bb1ea758cff97bdb03c5b2a5c5;hpb=ac2440f2cbbcb03a8f945f7b4c6943f91aeab46d;p=lttng-modules.git diff --git a/README.md b/README.md index f87b47bc..66bf9253 100644 --- a/README.md +++ b/README.md @@ -42,11 +42,23 @@ kernel, do: sudo depmod -a kernel_version +### Kernel built-in support + +It is also possible to build these modules as part of a kernel image. Simply +run the [`scripts/built-in.sh`](scripts/built-in.sh) script with the path to +your kernel source directory as an argument. It will symlink the +lttng-modules directory in the kernel sources and add an include in the kernel +Makefile. + +Then configure your kernel as usual and enable the `CONFIG_LTTNG` option. + + ### Required kernel config options Make sure your target kernel has the following config options enabled: - - `CONFIG_MODULES`: loadable module support + - `CONFIG_MODULES`: loadable module support (not strictly required + when built into the kernel) - `CONFIG_KALLSYMS`: see files in [`wrapper`](wrapper); this is necessary until the few required missing symbols are exported to GPL modules from mainline @@ -83,7 +95,7 @@ available from LTTng: number and name -Using +Usage ----- Use [LTTng-tools](https://lttng.org/download) to control the tracer. @@ -95,11 +107,7 @@ to print traces as a human-readable text log. Support ------- -So far, it has been tested on various vanilla Linux kernels from 2.6.38 -to 3.16, most of them on IA-32/x86-64 and some of them on ARM and Power-PC -32-bit. Linux 2.6.32 to 2.6.34 need up to 3 patches applied (refer to -[`linux-patches`](linux-patches)). It should work fine with newer kernels and -other architectures, but expect build issues with kernels older than 2.6.36. +Linux kernels >= 3.0 are supported. Notes