From 9fe14b784fc810e8db56f9f3cca5a5b6c4751af2 Mon Sep 17 00:00:00 2001 From: Sagar Arora Date: Mon, 13 Apr 2026 11:48:06 +0200 Subject: [PATCH] fix(record_db doc): correct the path for T_messages.txt and mention use of ninja/make Signed-off-by: Sagar Arora --- common/utils/T/DOC/T/basic.md | 12 ++++++++++-- common/utils/T/DOC/T/record_db.md | 10 +++++++--- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/common/utils/T/DOC/T/basic.md b/common/utils/T/DOC/T/basic.md index 0103c30de7..ff54c7efc6 100644 --- a/common/utils/T/DOC/T/basic.md +++ b/common/utils/T/DOC/T/basic.md @@ -67,18 +67,26 @@ the T tracer and only output on the terminal). The default is ## Run a tracer -Go into the directory `common/utils/T/tracer` (or -`cmake_targets/ran_build/build/common/utils/T/tracer`) and run for example the +Go into the directory `common/utils/T/tracer` and run for example the `enb` tracer: ```shell +#in common/utils/T/tracer directory ./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, if you want to trace a program running on `192.168.12.148` do: ```shell +# in common/utils/T/tracer directory ./enb -d ../T_messages.txt -ip 192.168.12.148 ``` diff --git a/common/utils/T/DOC/T/record_db.md b/common/utils/T/DOC/T/record_db.md index 2c3825252f..27444fa87c 100644 --- a/common/utils/T/DOC/T/record_db.md +++ b/common/utils/T/DOC/T/record_db.md @@ -44,6 +44,7 @@ Or, from an existing build directory using cmake: ```shell cd cmake_targets/ran_build/build cmake -DT_RECORD_DB=ON . +# use make or ninja make T_tools ``` @@ -53,6 +54,9 @@ The binary is then available in: 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 - 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 ClickHouse: ```shell -cd cmake_targets/ran_build/build/common/utils/T/tracer -./record_db -d ../T_messages.txt \ +cd cmake_targets/ran_build/build/ +./common/utils/T/tracer/record_db -d ../../../common/utils/T/T_messages.txt \ -ON \ -off VCD \ -off HEAVY \ @@ -108,7 +112,7 @@ The event selection rules are the same as for [`record`](./record.md): These options are processed in order. For example: ```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