RDKDEV-1444 Add Documentation RBus#450
Open
gourivarma3 wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new, comprehensive docs/README.md intended to provide generic RBus component documentation (architecture, threading, modules, configuration, and example flows) to complement existing repository docs.
Changes:
- Introduces an end-to-end RBus documentation page covering design, call flows, internal modules, and configuration.
- Documents build-time CMake options and key runtime/service dependencies.
- Adds illustrative Mermaid diagrams and CLI usage examples.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
karuna2git
previously approved these changes
Jul 16, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
| | `WITH_SPAKE2=ON` | `WITH_SPAKE2=1` | Enables SPAKE2+ key-exchange cipher between `rtrouted` and clients | OFF | | ||
| | `ENABLE_ADDRESS_SANITIZER=ON` | `-fsanitize=address` | Enables AddressSanitizer for memory-error detection during development | OFF | | ||
| | `ENABLE_RDKLOGGER=ON` | `ENABLE_RDKLOGGER` | Routes internal log output through the RDK Logger instead of the built-in `rtLog` handler | OFF | | ||
| | `BUILD_RBUS_DAEMON=ON` | — | Builds the `rtrouted` daemon and `rbus_session_mgr` service | ON | |
|
|
||
| **Platform and Integration Requirements:** | ||
|
|
||
| - **Build Dependencies**: cJSON library (required for all builds); MessagePack (`msgpack-c`) and `linenoise` required unless `BUILD_ONLY_RTMESSAGE=ON`. |
|
|
||
| | Configuration File | Purpose | Override Mechanism | | ||
| | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | ||
| | `/usr/lib/systemd/system/rbus.service` | Launches `rtrouted` as a forking service. `ExecStopPost` clears `/tmp/rbus_stopped`. | `RTROUTER_OPTIONAL_ARGS` environment variable in `ExecStart` | |
|
|
||
| ### Runtime Configuration | ||
|
|
||
| The router address used by client processes can be overridden at runtime by supplying a configuration file path to `rtConnection_CreateWithConfig`. The `rbuscli` utility accepts the router address as a command-line argument, allowing it to target a non-default `rtrouted` instance: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
RDKDEV-1444
Reason for Change:
To add a generic component Documentation for rbus.
Fix:
Added the README.md documentation
Signed-off-by: gourivarma3