RDKDEV-1434 Add Sceneset Documentation#38
Conversation
There was a problem hiding this comment.
Pull request overview
Adds in-repo component documentation for the SceneSet service (RDK app launcher), describing its boot-time responsibilities, COMRPC/Thunder plugin interactions, threading model, and configuration knobs.
Changes:
- Introduces a comprehensive
docs/README.mdcovering architecture, state flows, and runtime behavior (with Mermaid diagrams). - Documents key dependencies, systemd integration assumptions, and configuration files/parameters.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| - **Error Handling Strategy**: `Core::hresult` return codes from all COMRPC calls are checked and logged. A failed `StartPreinstall()` call falls through to `completeStartupAfterPreinstall()` immediately rather than waiting for a callback that will never arrive. Preinstall package states outside `INSTALLED` or `INSTALLING` mark the preinstall as failed, causing the preinstall directory to be preserved for retry on next boot. File rename failures in the download staging path fall back to a copy-then-delete sequence. | ||
|
|
||
| - **Logging & Diagnostics**: All output goes to stdout (`std::cout`) and stderr (`std::cerr`). The syslog-ng configuration defined in the Yocto recipe routes this output to `/opt/logs/sceneset.log` with a high log rate. Key log points include: COMRPC interface acquisition, sd_notify delivery, event handler registration, first-boot detection, preinstall start and completion, app launch and lifecycle transitions, OTA package detection, and shutdown sequence steps. |
There was a problem hiding this comment.
The syslog-ng configuration is present in the repository — sceneset_git.bb explicitly sets SYSLOG-NG_DESTINATION_sceneset = "sceneset.log" and SYSLOG-NG_LOGRATE_sceneset = "high". The original statement was directly sourced from this file.
The only valid point is that /opt/logs/ is a platform convention rather than an explicit declaration. The text has been updated to quote the bb file variables directly and note the path as conventional, keeping the content traceable without the overreach of the suggested change.
Added component documentation for sceneset.
I have read the CLA Document and I hereby sign the CLA