summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHannu Lounento <hannu.lounento@vaisala.com>2023-06-08 14:42:13 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-06-16 17:31:06 +0100
commitf5be1af663b24d17696039cf489f67644343d858 (patch)
treede0255ddf8610a7f6ef58aa5981fbb5fb5227bea
parentab06a2e244dacb02afc9de3d2bc8aa0bf8ee3269 (diff)
downloadpoky-f5be1af663b24d17696039cf489f67644343d858.tar.gz
profile-manual: fix blktrace remote usage instructions
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 (From yocto-docs rev: a54e08c2a6511d8acc0e60aec6f76b5ce511a1b2) Signed-off-by: Hannu Lounento <hannu.lounento@vaisala.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/profile-manual/usage.rst19
1 files changed, 10 insertions, 9 deletions
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
2423the traced device at all by providing native support for sending all 2423the traced device at all by providing native support for sending all
2424trace data over the network. 2424trace data over the network.
2425 2425
2426To have blktrace operate in this mode, start blktrace on the target 2426To have blktrace operate in this mode, start blktrace in server mode on the
2427system being traced with the -l option, along with the device to trace:: 2427host system, which is going to store the captured data::
2428 2428
2429 root@crownbay:~# blktrace -l /dev/sdc 2429 $ blktrace -l
2430 server: waiting for connections... 2430 server: waiting for connections...
2431 2431
2432On the host system, use the -h option to connect to the target system, 2432On the target system that is going to be traced, start blktrace in client
2433also passing it the device to trace:: 2433mode with the -h option to connect to the host system, also passing it the
2434device to trace::
2434 2435
2435 $ blktrace -d /dev/sdc -h 192.168.1.43 2436 root@crownbay:~# blktrace -d /dev/sdc -h 192.168.1.43
2436 blktrace: connecting to 192.168.1.43 2437 blktrace: connecting to 192.168.1.43
2437 blktrace: connected! 2438 blktrace: connected!
2438 2439
2439On the target system, you should see this:: 2440On the host system, you should see this::
2440 2441
2441 server: connection from 192.168.1.43 2442 server: connection from 192.168.1.43
2442 2443
@@ -2446,7 +2447,7 @@ In another shell, execute a workload you want to trace. ::
2446 Connecting to downloads.yoctoproject.org (140.211.169.59:80) 2447 Connecting to downloads.yoctoproject.org (140.211.169.59:80)
2447 linux-2.6.19.2.tar.b 100% \|*******************************\| 41727k 0:00:00 ETA 2448 linux-2.6.19.2.tar.b 100% \|*******************************\| 41727k 0:00:00 ETA
2448 2449
2449When it's done, do a Ctrl-C on the host system to stop the 2450When it's done, do a Ctrl-C on the target system to stop the
2450trace:: 2451trace::
2451 2452
2452 ^C=== sdc === 2453 ^C=== sdc ===
@@ -2454,7 +2455,7 @@ trace::
2454 CPU 1: 4109 events, 193 KiB data 2455 CPU 1: 4109 events, 193 KiB data
2455 Total: 11800 events (dropped 0), 554 KiB data 2456 Total: 11800 events (dropped 0), 554 KiB data
2456 2457
2457On the target system, you should also see a trace summary for the trace 2458On the host system, you should also see a trace summary for the trace
2458just ended:: 2459just ended::
2459 2460
2460 server: end of run for 192.168.1.43:sdc 2461 server: end of run for 192.168.1.43:sdc