[PATCH] docs: fix wrong proftool usage

[PATCH] docs: fix wrong proftool usage

[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>

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

Signed-off-by: Pavel Skripkin <paskripkin@gmail.com>
---
 doc/develop/trace.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/develop/trace.rst b/doc/develop/trace.rst
index 8425d843e9..9bbe1345d2 100644
--- a/doc/develop/trace.rst
+++ b/doc/develop/trace.rst
@@ -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!):
 
-- 
2.39.2

Re: [PATCH] docs: fix wrong proftool usage

[Simon Glass]

On Wed, 12 Apr 2023 at 13:05, Pavel Skripkin <paskripkin@gmail.com> wrote:
>
> 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>
> ---
>  doc/develop/trace.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Simon Glass <sjg@chromium.org>

Re: [PATCH] docs: fix wrong proftool usage

[Pavel Skripkin]

Hi Simon,

Simon Glass <sjg@chromium.org> says:
> On Wed, 12 Apr 2023 at 13:05, Pavel Skripkin <paskripkin@gmail.com> wrote:
>>
>> 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>
>> ---
>>  doc/develop/trace.rst | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> Reviewed-by: Simon Glass <sjg@chromium.org>

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

Re: [PATCH] docs: fix wrong proftool usage

[Tom Rini]

[-- Attachment #1: Type: text/plain, Size: 1147 bytes --]

On Tue, Apr 25, 2023 at 04:41:52PM +0300, Pavel Skripkin wrote:
> Hi Simon,
> 
> Simon Glass <sjg@chromium.org> says:
> > On Wed, 12 Apr 2023 at 13:05, Pavel Skripkin <paskripkin@gmail.com> wrote:
> > > 
> > > 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>
> > > ---
> > >  doc/develop/trace.rst | 2 +-
> > >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > Reviewed-by: Simon Glass <sjg@chromium.org>
> 
> 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.

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]