diff mbox series

[mickledore] profile-manual: fix blktrace remote usage instructions

Message ID 20230619084826.860933-1-michael.opdenacker@bootlin.com
State New
Headers show
Series [mickledore] profile-manual: fix blktrace remote usage instructions | expand

Commit Message

Michael Opdenacker June 19, 2023, 8:48 a.m. UTC 
From: Michael Opdenacker <michael.opdenacker@bootlin.com>

From: Hannu Lounento <hannu.lounento@vaisala.com>

The references to the target and host systems (i.e. the client and
server respectively) were swapped in the instructions.

Also, there's no need to specify the device node on the server command
line that is run on the host system.

The previous, incorrect, instructions resulted typically in:

    target# blktrace -l /dev/mmcblk1
    server: waiting for connections...

and

    host$ blktrace -d /dev/mmcblk2 -h target
    Invalid path /dev/mmcblk2 specified: 2/No such file or directory

unless the same device node happened to exist on the host system.

Based on

    target# blktrace --version
    blktrace version 2.0.0

and

    host$ blktrace --version
    blktrace version 2.0.0

Signed-off-by: Hannu Lounento <hannu.lounento@vaisala.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/profile-manual/usage.rst | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)
diff mbox series

Patch

diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst
index 703ac459a0..6f0b0418e7 100644
--- a/documentation/profile-manual/usage.rst
+++ b/documentation/profile-manual/usage.rst
@@ -2423,20 +2423,21 @@  tracer writes to, blktrace provides a way to trace without perturbing
 the traced device at all by providing native support for sending all
 trace data over the network.
 
-To have blktrace operate in this mode, start blktrace on the target
-system being traced with the -l option, along with the device to trace::
+To have blktrace operate in this mode, start blktrace in server mode on the
+host system, which is going to store the captured data::
 
-   root@crownbay:~# blktrace -l /dev/sdc
+   $ blktrace -l
    server: waiting for connections...
 
-On the host system, use the -h option to connect to the target system,
-also passing it the device to trace::
+On the target system that is going to be traced, start blktrace in client
+mode with the -h option to connect to the host system, also passing it the
+device to trace::
 
-   $ blktrace -d /dev/sdc -h 192.168.1.43
+   root@crownbay:~# blktrace -d /dev/sdc -h 192.168.1.43
    blktrace: connecting to 192.168.1.43
    blktrace: connected!
 
-On the target system, you should see this::
+On the host system, you should see this::
 
    server: connection from 192.168.1.43
 
@@ -2446,7 +2447,7 @@  In another shell, execute a workload you want to trace. ::
    Connecting to downloads.yoctoproject.org (140.211.169.59:80)
    linux-2.6.19.2.tar.b 100% \|*******************************\| 41727k 0:00:00 ETA
 
-When it's done, do a Ctrl-C on the host system to stop the
+When it's done, do a Ctrl-C on the target system to stop the
 trace::
 
    ^C=== sdc ===
@@ -2454,7 +2455,7 @@  trace::
     CPU  1:                 4109 events,      193 KiB data
     Total:                 11800 events (dropped 0),      554 KiB data
 
-On the target system, you should also see a trace summary for the trace
+On the host system, you should also see a trace summary for the trace
 just ended::
 
    server: end of run for 192.168.1.43:sdc