Skip to content

Commit b9f7f78

Browse files
committed
Minor documentation updates
1 parent 0666ad8 commit b9f7f78

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ auto conn2 = dmq::DataBus::Subscribe<int>("status", [](int s) {
311311

312312
<img src="docs/dmq-spy-screenshot.png" alt="DelegateMQ Spy Screenshot" style="max-width: 800px; width: 100%;">
313313

314-
To use the Spy tool, simply enable the `DMQ_DATABUS_SPY` option in your application's build and start the `dmq-spy` console. See the [DelegateMQ-Tools repository](https://github.com/endurodave/DelegateMQ-Tools) for implementation details.
314+
To use the Spy tool, simply enable the `DMQ_DATABUS_TOOLS` option in your application's build and start the `dmq-spy` console. See the [DelegateMQ-Tools repository](https://github.com/endurodave/DelegateMQ-Tools) for implementation details.
315315

316316
# Modular Architecture
317317

docs/DETAILS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -597,7 +597,7 @@ The sender calls `(*m_channel)(value)` or `RemoteInvokeWait(*m_channel, value)`.
597597

598598
**[DelegateMQ Spy](https://github.com/endurodave/DelegateMQ-Tools)** is a standalone TUI diagnostic tool that provides a "Software Logic Analyzer" view of the DataBus. It captures, filters, and displays all bus traffic in real-time without blocking the main application thread.
599599

600-
To enable spy support in a sample project, build with `-DDMQ_DATABUS_SPY=ON`. This activates an asynchronous "Spy Bridge" that exports packets over UDP to the standalone console.
600+
To enable spy support in a sample project, build with `-DDMQ_DATABUS_TOOLS=ON`. This activates an asynchronous "Spy Bridge" that exports packets over UDP to the standalone console.
601601

602602
### Example: Local Pub/Sub
603603

example/sample-projects/databus-multicast/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ This example demonstrates a distributed system using `dmq::DataBus` over **UDP M
4040
This project includes optional support for the **DelegateMQ Spy Console**. When enabled, the application exports all bus traffic to a multicast group, allowing multiple consoles to monitor the system at once.
4141

4242
### Enabling Spy
43-
To enable the spy bridge, configure the project with the `DMQ_DATABUS_SPY` option set to `ON`:
43+
To enable the spy bridge, configure the project with the `DMQ_DATABUS_TOOLS` option set to `ON`:
4444

4545
```bash
46-
cmake -B build -DDMQ_DATABUS_SPY=ON .
46+
cmake -B build -DDMQ_DATABUS_TOOLS=ON .
4747
cmake --build build --config Release
4848
```
4949

example/sample-projects/databus-shapes/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The **Shapes Demo** is a graphical demonstration of the **DelegateMQ DataBus** c
3737
This project is fully integrated with the **DelegateMQ Spy Console**.
3838

3939
### Enabling the Spy Bridge
40-
The server-side bridge is enabled by default in the `CMakeLists.txt` via the `DMQ_DATABUS_SPY` option. To monitor the raw coordinate data flowing through the bus:
40+
The server-side bridge is enabled by default in the `CMakeLists.txt` via the `DMQ_DATABUS_TOOLS` option. To monitor the raw coordinate data flowing through the bus:
4141

4242
1. Start the **Spy Console** from the `DelegateMQ-Tools` project:
4343
```bash

example/sample-projects/databus/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ This project includes optional support for the **DelegateMQ Spy Console**. When
4444
- `Bitsery` must be available in the workspace (fetched via `01_fetch_repos.py`).
4545

4646
### Enabling Spy
47-
To enable the spy bridge, configure the project with the `DMQ_DATABUS_SPY` option set to `ON`:
47+
To enable the spy bridge, configure the project with the `DMQ_DATABUS_TOOLS` option set to `ON`:
4848

4949
```bash
50-
cmake -B build -DDMQ_DATABUS_SPY=ON .
50+
cmake -B build -DDMQ_DATABUS_TOOLS=ON .
5151
cmake --build build --config Release
5252
```
5353

0 commit comments

Comments
 (0)