diff mbox

trace: docs: add trace file description

Message ID 1405049077-26266-1-git-send-email-chen.fan.fnst@cn.fujitsu.com
State New
Headers show

Commit Message

chenfan July 11, 2014, 3:24 a.m. UTC
When user used the trace print command from docs/tracing.txt:
  ./scripts/simpletrace.py trace-events trace-*

the user maybe be misled by the "trace-*", because if user
directly copy the comand line to run, there alway print the
bored message:
"usage: ./scripts/simpletrace.py <trace-events> <trace-file>"

then we should describe that the "trace-*" represented.

Signed-off-by: Chen Fan <chen.fan.fnst@cn.fujitsu.com>
---
 docs/tracing.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Stefan Hajnoczi Aug. 28, 2014, 2:08 p.m. UTC | #1
On Fri, Jul 11, 2014 at 11:24:37AM +0800, Chen Fan wrote:
> When user used the trace print command from docs/tracing.txt:
>   ./scripts/simpletrace.py trace-events trace-*
> 
> the user maybe be misled by the "trace-*", because if user
> directly copy the comand line to run, there alway print the
> bored message:
> "usage: ./scripts/simpletrace.py <trace-events> <trace-file>"
> 
> then we should describe that the "trace-*" represented.
> 
> Signed-off-by: Chen Fan <chen.fan.fnst@cn.fujitsu.com>
> ---
>  docs/tracing.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Thanks, applied to my tracing tree:
https://github.com/stefanha/qemu/commits/tracing

Stefan
diff mbox

Patch

diff --git a/docs/tracing.txt b/docs/tracing.txt
index c6ab1c1..c2299ce 100644
--- a/docs/tracing.txt
+++ b/docs/tracing.txt
@@ -23,7 +23,7 @@  for debugging, profiling, and observing execution.
 
 4. Pretty-print the binary trace file:
 
-    ./scripts/simpletrace.py trace-events trace-*
+    ./scripts/simpletrace.py trace-events trace-* # Override * with QEMU <pid>
 
 == Trace events ==