X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;ds=sidebyside;f=README.md;h=38d533953055443563d287363584c0d413e59f1d;hb=93e9f463b4cc4af01a007499de4d61222668b6b7;hp=450f3630d582ebf63f47161e93c23cacb59fd544;hpb=47491cdffd394f09524657e9be1e90d4bb644f2f;p=lttng-modules.git

diff --git a/README.md b/README.md
index 450f3630..38d53395 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,7 @@ Make sure your target kernel has the following config options enabled:
   - `CONFIG_TRACEPOINTS`: kernel tracepoint instrumentation
      (enabled as a side-effect of any of the perf/ftrace/blktrace
      instrumentation features).
+  - `CONFIG_KPROBES` (5.7+): use kallsyms for kernel 5.7 and newer.
 
 
 ### Supported (optional) kernel config options
@@ -94,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
 -----------------------
 
@@ -120,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
@@ -132,3 +148,25 @@ 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.
+
+
+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).