Commit d694aa68 authored by Jaroslava Fiedlerova's avatar Jaroslava Fiedlerova

Merge remote-tracking branch 'origin/record_db_doc_fix' into integration_2026_w16 (!4046)

fix(record_db doc): correct the path for T_messages.txt and mention use of ninja/make

The commit !4038 (51d84419) provided the wrong path for T_messages.txt. The path
it provided holds if the T tracer is built manually using make.

A note to explicitly mention the path for T_messages.txt when T tracer is built
using make.

Signed-off-by: Sagar Arora sagar.arora@openairinterface.org
parents 99c0e6a1 9fe14b78
...@@ -67,18 +67,26 @@ the T tracer and only output on the terminal). The default is ...@@ -67,18 +67,26 @@ the T tracer and only output on the terminal). The default is
## Run a tracer ## Run a tracer
Go into the directory `common/utils/T/tracer` (or Go into the directory `common/utils/T/tracer` and run for example the
`cmake_targets/ran_build/build/common/utils/T/tracer`) and run for example the
`enb` tracer: `enb` tracer:
```shell ```shell
#in common/utils/T/tracer directory
./enb -d ../T_messages.txt ./enb -d ../T_messages.txt
``` ```
You can also run it from `cmake_targets/ran_build/build/` directory:
```shell
# in cmake_targets/ran_build/build directory
./common/utils/T/tracer/enb -d ../../../common/utils/T/T_messages.txt
```
To trace a remote program, use the `-ip` option. For example, To trace a remote program, use the `-ip` option. For example,
if you want to trace a program running on `192.168.12.148` do: if you want to trace a program running on `192.168.12.148` do:
```shell ```shell
# in common/utils/T/tracer directory
./enb -d ../T_messages.txt -ip 192.168.12.148 ./enb -d ../T_messages.txt -ip 192.168.12.148
``` ```
......
...@@ -44,6 +44,7 @@ Or, from an existing build directory using cmake: ...@@ -44,6 +44,7 @@ Or, from an existing build directory using cmake:
```shell ```shell
cd cmake_targets/ran_build/build cd cmake_targets/ran_build/build
cmake -DT_RECORD_DB=ON . cmake -DT_RECORD_DB=ON .
# use make or ninja
make T_tools make T_tools
``` ```
...@@ -53,6 +54,9 @@ The binary is then available in: ...@@ -53,6 +54,9 @@ The binary is then available in:
cmake_targets/ran_build/build/common/utils/T/tracer/record_db cmake_targets/ran_build/build/common/utils/T/tracer/record_db
``` ```
**NOTE*: Unlike other docs on T Tracer for `record_db` we are building in cmake
directory rather than in the directory of T.
## Prerequisites ## Prerequisites
- a running ClickHouse server reachable from `record_db` - a running ClickHouse server reachable from `record_db`
...@@ -84,8 +88,8 @@ To enable all events except the most verbose groups and write them to ...@@ -84,8 +88,8 @@ To enable all events except the most verbose groups and write them to
ClickHouse: ClickHouse:
```shell ```shell
cd cmake_targets/ran_build/build/common/utils/T/tracer cd cmake_targets/ran_build/build/
./record_db -d ../T_messages.txt \ ./common/utils/T/tracer/record_db -d ../../../common/utils/T/T_messages.txt \
-ON \ -ON \
-off VCD \ -off VCD \
-off HEAVY \ -off HEAVY \
...@@ -108,7 +112,7 @@ The event selection rules are the same as for [`record`](./record.md): ...@@ -108,7 +112,7 @@ The event selection rules are the same as for [`record`](./record.md):
These options are processed in order. For example: These options are processed in order. For example:
```shell ```shell
./record_db -d ../T_messages.txt -OFF -on GNB_PHY_UL_FD_PUSCH_IQ -on GNB_PHY_UL_PAYLOAD_RX_BITS ./common/utils/T/tracer/record_db -d ../../../common/utils/T/T_messages.txt -OFF -on GNB_PHY_UL_FD_PUSCH_IQ -on GNB_PHY_UL_PAYLOAD_RX_BITS
``` ```
This starts from everything disabled and enables only the two listed This starts from everything disabled and enables only the two listed
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment