readme: add some initial context around developer tools#10596
readme: add some initial context around developer tools#10596lgirdwood wants to merge 1 commit intothesofproject:mainfrom
Conversation
lgirdwood
requested review from
abonislawski,
dbaluta,
kv2019i,
lbetlej,
mmaka1 and
plbossart
as code owners
There was a problem hiding this comment.
Pull request overview
Adds initial high-level documentation for SOF developer/debug tooling, plus expands the helper scripts README to better describe common build/test workflows.
Changes:
- Added new README documents for debug subsystems: tester harness, telemetry/perf, GDB stub, and debug_stream.
- Restructured and expanded
scripts/Readme.mdwith clearer script names/options and additional build/testbench guidance.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| src/debug/tester/readme.md | Documents the tester “pseudo-component” and how to enable/extend it. |
| src/debug/telemetry/readme.md | Documents telemetry/performance measurement capabilities and Kconfig toggles. |
| src/debug/gdb/readme.md | Documents the GDB remote debugging stub architecture and usage. |
| src/debug/debug_stream/readme.md | Documents debug_stream purpose, enablement, and host extraction. |
| scripts/Readme.md | Reworks build/tooling/testbench/Docker documentation for developer scripts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Architecture | ||
|
|
||
| The architecture functions identical to an IPC Version 4 standard module, containing `comp_driver`, `comp_dev`, `comp_buffer` wrappers and implementing `tester_params()` handlers. |
There was a problem hiding this comment.
This describes the module as implementing tester_params() handlers, but the implementation uses the module interface callbacks (e.g., .set_configuration = tester_set_configuration) and does not appear to define tester_params(). Update the wording to match the actual entry points used by the tester module.
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
High level documentation describing developer and debug tooling. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
High level documentation describing developer and debug tooling.