docs: fix wrong proftool usage
authorPavel Skripkin <paskripkin@gmail.com>
Wed, 12 Apr 2023 19:05:31 +0000 (22:05 +0300)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Thu, 4 May 2023 07:57:43 +0000 (09:57 +0200)
Guide shows incorrect usage of proftool, which is confusing. If proftool
is used w/o '-o' argument it complains like following

$ ./sandbox/tools/proftool -m sandbox/System.map -t trace dump-ftrace > trace.dat
Must provide trace data, System.map file and output file
Usage: proftool [-cmtv] <cmd> <profdata>

s/>/-o/ fixes it and proftool outputs decoded data to trace.dat

Signed-off-by: Pavel Skripkin <paskripkin@gmail.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
doc/develop/trace.rst

index 8425d84..9bbe134 100644 (file)
@@ -100,7 +100,7 @@ Then run proftool to convert the trace information to ftrace format
 
 .. code-block:: console
 
-    $ ./sandbox/tools/proftool -m sandbox/System.map -t trace dump-ftrace >trace.dat
+    $ ./sandbox/tools/proftool -m sandbox/System.map -t trace dump-ftrace -o trace.dat
 
 Finally run kernelshark to display it (note it only works with `.dat` files!):