From c0e852f37036a97d7f4dd633db69d2d4a75f12c3 Mon Sep 17 00:00:00 2001
From: Julianne Swinoga <Julianne.Swinoga@canonical.com>
Date: Tue, 12 Sep 2023 15:27:25 -0400
Subject: [PATCH] fixup! Update README.md script output after previous
 changes/bugfixes

Update CLI docs too
---
 docs/source/cli-interface.rst | 44 ++++++++++++++++++++---------------
 1 file changed, 25 insertions(+), 19 deletions(-)

diff --git a/docs/source/cli-interface.rst b/docs/source/cli-interface.rst
index c72afab..02bb3f3 100644
--- a/docs/source/cli-interface.rst
+++ b/docs/source/cli-interface.rst
@@ -1,32 +1,38 @@
 Command Line Interface
 ======================
 
-The ``file_parser`` module can also be run as a script, which will provide simple statistics on the trace as well as dumping all the events in the trace:
+The ``file_parser`` module can also be run as a script, which will provide simple statistics on the trace as well as dumping all the events in the trace.
+It can be run by either:
+
+* Running the module manually: ``python3 -m tracex_parser.file_parser``
+* Using the newly installed command: ``parse-trx``
+
+Both run methods are identical.
 
 .. code-block:: console
 
-    $ python3 -m tracex_parser.file_parser -vvv ./demo_threadx.trx
+    $ parse-trx -vvv ./demo_threadx.trx
     Parsing ./demo_threadx.trx
     total events: 974
     object registry size: 16
-    delta ticks: 156206
+    delta ticks: 40402
     Event Histogram:
-    queueSend           493
-    queueReceive        428
-    threadResume        19
-    threadSuspend       16
-    mtxPut              4
-    isrExit             3
-    isrEnter            3
-    semGet              2
-    semPut              2
-    threadSleep         2
-    mtxGet              2
+    queueSend     493
+    queueReceive  428
+    threadResume  19
+    threadSuspend 16
+    mtxPut        4
+    isrEnter      3
+    isrExit       3
+    semPut        2
+    semGet        2
+    mtxGet        2
+    threadSleep   2
     All events:
-    4265846278:thread 7 threadResume(thread_ptr=thread 6,prev_state=0xd,stack_ptr=0x12980,next_thread=)
-    4265846441:thread 7 mtxPut(obj_id=mutex 0,owning_thread=0x6adc,own_cnt=0x1,stack_ptr=0x129a0)
-    4265846566:thread 7 mtxPut(obj_id=mutex 0,owning_thread=0x6adc,own_cnt=0x2,stack_ptr=0x129a0)
-    4265846825:thread 4 threadSuspend(thread_ptr=thread 4,new_state=0x6,stack_ptr=0x11d70,next_thread=thread 7)
-    4265846953:thread 4 semGet(obj_id=semaphore 0,timeout=WaitForever,cur_cnt=0x0,stack_ptr=0x11d98)
+    2100:thread 2 queueReceive(queue_ptr=0x6b84,dst_ptr=0x115a0,timeout=WaitForever,enqueued=0x13)
+    1939:thread 2 queueReceive(queue_ptr=0x6b84,dst_ptr=0x115a0,timeout=WaitForever,enqueued=0x12)
+    1778:thread 2 queueReceive(queue_ptr=0x6b84,dst_ptr=0x115a0,timeout=WaitForever,enqueued=0x11)
+    1617:thread 2 queueReceive(queue_ptr=0x6b84,dst_ptr=0x115a0,timeout=WaitForever,enqueued=0x10)
+    1456:thread 2 queueReceive(queue_ptr=0x6b84,dst_ptr=0x115a0,timeout=WaitForever,enqueued=0xf)
     ...