Skip to content

Commit 97b8878

Browse files
committed
Fix: format command examples in README and improve USDT documentation clarity
1 parent fc11c71 commit 97b8878

File tree

2 files changed

+23
-17
lines changed

2 files changed

+23
-17
lines changed

app/sample/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -55,14 +55,14 @@ The dir include the simple sample code for how to develop application quickly ba
5555
2. Launch the TX sample. The example below keeps every frame below the 255-byte UDW limit returned by `st40p_tx_max_udw_buff_size()` so that each payload fits into a single RFC 8331 RTP packet.
5656
```bash
5757
./build/app/TxSt40PipelineSample \
58-
--p_port 0000:af:01.0 \
59-
--p_tx_ip 239.1.1.1 \
60-
--p_sip 192.168.96.2 \
61-
--udp_port 20000 \
62-
--payload_type 40 \
63-
--sessions_cnt 1 \
64-
--tx_url /tmp/anc_payload.bin \
65-
--ext_frame
58+
--p_port 0000:af:01.0 \
59+
--p_tx_ip 239.1.1.1 \
60+
--p_sip 192.168.96.2 \
61+
--udp_port 20000 \
62+
--payload_type 40 \
63+
--sessions_cnt 1 \
64+
--tx_url /tmp/anc_payload.bin \
65+
--ext_frame
6666
```
6767

6868
Helpful switches:
@@ -76,14 +76,14 @@ Match the TX parameters on the receiver. Enabling `--rx_dump` writes a human-rea
7676

7777
```bash
7878
./build/app/RxSt40PipelineSample \
79-
--p_port 0000:af:01.0 \
80-
--p_rx_ip 239.1.1.1 \
81-
--p_sip 192.168.96.2 \
82-
--udp_port 20000 \
83-
--payload_type 40 \
84-
--sessions_cnt 1 \
85-
--rx_url /tmp/anc_dump.txt \
86-
--rx_dump
79+
--p_port 0000:af:01.0 \
80+
--p_rx_ip 239.1.1.1 \
81+
--p_sip 192.168.96.2 \
82+
--udp_port 20000 \
83+
--payload_type 40 \
84+
--sessions_cnt 1 \
85+
--rx_url /tmp/anc_dump.txt \
86+
--rx_dump
8787
```
8888

8989
The runtime log summarizes the number of metadata entries and UDW bytes received per frame, while the dump files capture DID/SDID/line information followed by the raw payload so you can diff TX/RX easily.

doc/usdt.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,13 @@ usdt::st40p:rx_frame_dump {
772772
' -p $(pidof RxSt40PipelineSample)
773773
```
774774

775-
`rx_frame_dump` fires only while you are attached; `arg2` is the metadata entry count and `arg3` is the number of payload bytes flushed to the generated file (for example `imtl_usdt_st40prx_s0_447_SzG5Yv.bin`). Attach `usdt::sys:log_msg` alongside these probes if you want the scheduler/tasklet summaries without reconfiguring the sample log level. If `bpftrace` reports `couldn't get argument N`, rebuild/install `libmtl.so` with `-Denable_usdt=true` so the refreshed probe metadata (including the extra RX meta argument and the renamed dump byte field) is visible system-wide.
775+
`rx_frame_dump` fires only while you are attached; `arg2` is the metadata entry count and
776+
`arg3` is the number of payload bytes flushed to the generated file (for example
777+
`imtl_usdt_st40prx_s0_447_SzG5Yv.bin`). Attach `usdt::sys:log_msg` alongside these probes if
778+
you want the scheduler/tasklet summaries without reconfiguring the sample log level. If
779+
`bpftrace` reports `couldn't get argument N`, rebuild/install `libmtl.so` with
780+
`-Denable_usdt=true` so the refreshed probe metadata (including the extra RX meta argument and
781+
the renamed dump byte field) is visible system-wide.
776782

777783
### 2.6. st20p tracing
778784

0 commit comments

Comments
 (0)