X-Git-Url: http://git.liburcu.org/?p=lttng-modules.git;a=blobdiff_plain;f=README.md;h=66bf925394dfe099c9ee185bb8664ee742f25996;hp=7b04cd83b04991153ce8f7282ef3203a24489661;hb=HEAD;hpb=a65765406b03e4f3b7a4303e1c9ed83c86cdd358 diff --git a/README.md b/README.md index 7b04cd83..d1e4dbb6 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,21 @@ available from LTTng: - `CONFIG_KALLSYMS_ALL`: state dump of mapping between block device number and name +### LTTng specific kernel config options + +The following kernel configuration options are provided by LTTng: + + - `CONFIG_LTTNG`: Build LTTng (Defaults to 'm'). + - `CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM`: Enable the experimental bitwise + enumerations (Defaults to 'n'). This can be enabled by building with: + + make CONFIG_LTTNG_EXPERIMENTAL_BITWISE_ENUM=y + + - `CONFIG_LTTNG_CLOCK_PLUGIN_TEST`: Build the test clock plugin (Defaults to + 'm'). This plugin overrides the trace clock and should always be built as a + module for testing. + + Customization/Extension ----------------------- @@ -121,7 +136,7 @@ to print traces as a human-readable text log. Support ------- -Linux kernels >= 3.0 are supported. +Linux kernels >= 4.4 are supported. Notes @@ -133,3 +148,45 @@ Each PMU counter has its zero value set when it is attached to a context with add-context. Therefore, it is normal that the same counters attached to both the stream context and event context show different values for a given event; what matters is that they increment at the same rate. + + +Supported versions +------------------ + +The LTTng project supports the last two released stable versions +(e.g. stable-2.13 and stable-2.12). + +Fixes are backported from the master branch to the last stable version +unless those fixes would break the ABI or API. Those fixes may be backported +to the second-last stable version, depending on complexity and ABI/API +compatibility. + +Security fixes are backported from the master branch to both of the last stable +version and the the second-last stable version. + +New kernel version enablement commits are integrated into the master branch and +backported to the last stable version. + +New features are integrated into the master branch and not backported to the +last stable branch. + +Contacts +-------- + +You can contact the maintainers on the following mailing list: +`lttng-dev@lists.lttng.org`. + +IRC channel: [#lttng](irc://irc.oftc.net/lttng) on the OFTC network + +Bug tracker: [LTTng-modules bug tracker](https://bugs.lttng.org/projects/lttng-modules) + +Code review: [_lttng-modules_ project](https://review.lttng.org/q/project:lttng-modules) on LTTng Review + +Continuous integration: [LTTng-modules](https://ci.lttng.org/view/LTTng-modules/) on LTTng's CI + +GitHub mirror: [lttng/lttng-modules](https://github.com/lttng/lttng-modules) + +Patches are principally submitted and reviewed on [LTTng Review](https://review.lttng.org), +but may also be submitted to the [mailing list](mailto:lttng-dev@lists.lttng.org) +with the subject prefix `PATCH lttng-modules` or by pull request on the +[GitHub mirror](https://github.com/lttng/lttng-modules).