X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=README.md;h=220438d8c901b54b15fd07e05fe64d4efccc3bf6;hb=refs%2Fheads%2Fstable-2.10;hp=9934d2ef35eb3fb6a604d444ce09328e436da01e;hpb=f0003cd3fd6c0cad8e9a76853b5f67486579cc06;p=lttng-modules.git diff --git a/README.md b/README.md index 9934d2ef..220438d8 100644 --- a/README.md +++ b/README.md @@ -42,11 +42,22 @@ 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 [`built-in.sh`](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 +94,7 @@ available from LTTng: number and name -Using +Usage ----- Use [LTTng-tools](https://lttng.org/download) to control the tracer. @@ -95,7 +106,8 @@ to print traces as a human-readable text log. Support ------- -Linux kernels >= 2.6.36 are supported. +Linux kernels >= 2.6.36 are supported. The stable-2.10 branch (EOL) +supports kernels up to 5.6.19. Notes