[PATCH 3/3] perf/probe: docs: Add --bootconfig option to perf-probe manual

[Masami Hiramatsu]

Add --bootconfig option and example to the perf-probe manual.

Signed-off-by: Masami Hiramatsu <mhiramat@xxxxxxxxxx>
---
 tools/perf/Documentation/perf-probe.txt |   15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/perf-probe.txt b/tools/perf/Documentation/perf-probe.txt
index ed3ecfa422e1..d0908170c3d2 100644
--- a/tools/perf/Documentation/perf-probe.txt
+++ b/tools/perf/Documentation/perf-probe.txt
@@ -103,7 +103,14 @@ OPTIONS
 -D::
 --definition=::
 	Show trace-event definition converted from given probe-event instead
-	of write it into tracing/[k,u]probe_events.
+	of write it into tracing/[k,u]probe_events. This accepts --bootconfig
+	option.
+
+--bootconfig::
+	Show the trace-event definition in Extra Boot Configuration (bootconfig)
+	syntax. This helps users to write the probe event definitions for the
+	boot-time tracing.
+	Note that this must be used with --definition(-D) option.
 
 --filter=FILTER::
 	(Only for --vars and --funcs) Set filter. FILTER is a combination of glob
@@ -294,6 +301,12 @@ Add a probe in a source file using special characters by backslash escape
 
  ./perf probe -x /opt/test/a.out 'foo\+bar.c:4'
 
+Define a kprobe event on the line 7 of path_lookup for the boot-time tracing
+and set it to the initrd.img.
+
+ ./perf probe -k /boot/vmlinux --bootconfig -D "path_lookup:7" > tmp.bconf
+ bootconfig -a tmp.bconf /boot/initrd.img
+
 
 SEE ALSO
 --------