monitor: Update documentation
authorLuiz Augusto von Dentz <luiz.von.dentz@intel.com>
Fri, 28 Jul 2023 00:16:58 +0000 (17:16 -0700)
committerAyush Garg <ayush.garg@samsung.com>
Fri, 5 Jan 2024 13:34:03 +0000 (19:04 +0530)
This updates the documentation to mention gnuplot usage.

monitor/btmon.rst
monitor/main.c

index 0ab13eb..82f9381 100644 (file)
@@ -33,7 +33,9 @@ OPTIONS
 -w FILE, --write FILE       Save traces in btsnoop format to *FILE*.
 -a FILE, --analyze FILE     Analyze traces in btsnoop format from *FILE*.
                             It displays the devices found in the *FILE* with
-                            its packets by type.
+                           its packets by type. If gnuplot is installed on
+                           the system it also attempts to plot packet latency
+                           graph.
 -s SOCKET, --server SOCKET  Start monitor server socket.
 -p PRIORITY, --priority PRIORITY  Show only priority or lower for user log.
 
index 9338d74..ff6fa3c 100755 (executable)
@@ -50,6 +50,9 @@ static void usage(void)
                "\t-r, --read <file>      Read traces in btsnoop format\n"
                "\t-w, --write <file>     Save traces in btsnoop format\n"
                "\t-a, --analyze <file>   Analyze traces in btsnoop format\n"
+               "\t                       If gnuplot is installed on the\n"
+                "\t                       system it will also attempt to plot\n"
+               "\t                       packet latency graph.\n"
                "\t-s, --server <socket>  Start monitor server socket\n"
                "\t-p, --priority <level> Show only priority or lower\n"
                "\t-i, --index <num>      Show only specified controller\n"