Skip to contentSkip to conversation

docs: fix wrong proftool usage

PATCH In review Pavel Skripkin 3 participants 4 messages Apr 13, 2023 – Apr 25, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: fix wrong proftool usage

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

---
 doc/develop/trace.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/develop/trace.rst +1 -1
index 8425d843e9..9bbe1345d2 100644
@@ -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!):
 
Signature · 1 line
2.39.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 8 lines · Pavel Skripkin

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>
Quoted 6 lines

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

---
 doc/develop/trace.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
#2 lore raw

Hi Simon,

Simon Glass <[email protected]> says:

Quoted 9 lines · Pavel Skripkin
Quoted 8 lines

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>
Quoted 8 lines
Quoted 6 lines

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

---
 doc/develop/trace.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Thank you for review!

+Tom, I guess?

@Tom, could you, please, pick following patch?

https://lists.denx.de/pipermail/u-boot/2023-April/515194.html

With regards,
Pavel Skripkin

#3 lore raw
Quoted 21 lines · Pavel Skripkin

Hi Simon,

Simon Glass <[email protected]> says:

Quoted 9 lines · Pavel Skripkin
Quoted 8 lines

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>
Quoted 8 lines
Quoted 6 lines

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

---
 doc/develop/trace.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 8 lines

Thank you for review!

+Tom, I guess?

@Tom, could you, please, pick following patch?

https://lists.denx.de/pipermail/u-boot/2023-April/515194.html

Heinrich takes doc patches and I've assigned it to him in patchwork, thanks for posting.

Signature · 1 line
Tom