tracing/user_events: Document multi-format flag
authorBeau Belgrave <beaub@linux.microsoft.com>
Thu, 22 Feb 2024 00:18:07 +0000 (00:18 +0000)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Mon, 18 Mar 2024 14:13:16 +0000 (10:13 -0400)
commit3727db1c09b44c5bdcf2497a538da24beee16a3a
treea66e72134532aa36b620a8500dbb6dbbdf2ef47e
parentbcb7bdcc17e0e8d79b19748d912ae6991f087345
tracing/user_events: Document multi-format flag

User programs can now ask user_events to handle the synchronization of
multiple different formats for an event with the same name via the new
USER_EVENT_REG_MULTI_FORMAT flag.

Add a section for USER_EVENT_REG_MULTI_FORMAT that explains the intended
purpose and caveats of using it. Explain how deletion works in these
cases and how to use /sys/kernel/tracing/dynamic_events for per-version
deletion.

Link: https://lore.kernel.org/linux-trace-kernel/20240222001807.1463-5-beaub@linux.microsoft.com
Signed-off-by: Beau Belgrave <beaub@linux.microsoft.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Documentation/trace/user_events.rst