tracer: tools: add a brief tool description

diff --git a/tracer/gsttr-stats.py b/tracer/gsttr-stats.py
index 5c3f536f1301c5d1b57311c26a5dac5fe1a97bbc..3d9374ada37f36b4521465ebd18be5b078c26c0a 100644 (file)
--- a/tracer/gsttr-stats.py
+++ b/tracer/gsttr-stats.py
@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 '''
+Aggregate values for each tracer event type and print them with some statistics.
+
 How to run:
 1) generate some log
 GST_DEBUG="GST_TRACER:7" GST_TRACERS="stats;rusage;latency" GST_DEBUG_FILE=trace.log <application>

diff --git a/tracer/gsttr-tsplot.py b/tracer/gsttr-tsplot.py
index 0afc9a48dc3f36bebe1e3de27958d659634fb1fc..d8ccfd245cffffc582e95de3089c151c1fae9a64 100644 (file)
--- a/tracer/gsttr-tsplot.py
+++ b/tracer/gsttr-tsplot.py
@@ -1,5 +1,8 @@
 #!/usr/bin/env python3
 '''
+Plot buffer pts and events in relation to the wall clock. The plots can be used
+to spot anomalies, such as processing gaps.
+
 How to run:
 1) generate a log
 GST_DEBUG="GST_TRACER:7" GST_TRACERS=stats GST_DEBUG_FILE=trace.log <application>