Repository navigation
[projmgr] Add debugger rtt nodes and stdio/telnet alias to align with documentation - #2713
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block the stdio and RTT configuration changes.
No open issues 🎉
What changed in this PR
This PR aligns projmgr’s debugger schema, parsing, and cbuild-run generation with documented stdio and RTT file options, addressing issue #2711.
Changes:
- Adds
stdiowith precedence over the legacytelnetinput alias, while preserving legacyfileindependently. - Supports RTT file mode and explicit input/output filenames, including access-sequence expansion and path rebasing.
- Adds parser, schema-validation, and conversion tests for aliases, defaults, filenames, and invalid inputs.
| File | Description |
|---|---|
tools/projmgr/test/src/ProjMgrYamlParserUnitTest.cpp |
Tests alias parsing and stdio precedence. |
tools/projmgr/test/src/ProjMgrUnitTests.cpp |
Tests file conversion, defaults, path rebasing, and legacy compatibility. |
tools/projmgr/test/src/ProjMgrSchemaCheckerUnitTests.cpp |
Tests accepted and rejected stdio/RTT configurations. |
tools/projmgr/test/data/TestRunDebug/stdio.csolution.yml |
Adds a fixture covering stdio filenames and RTT channel modes. |
tools/projmgr/src/ProjMgrYamlParser.cpp |
Parses stdio aliases, defaults, and RTT channel filenames. |
tools/projmgr/src/ProjMgrWorker.cpp |
Processes debugger file paths and access sequences. |
tools/projmgr/src/ProjMgrRunDebug.cpp |
Collects stdio settings and assigns default filenames and ports. |
tools/projmgr/src/ProjMgrCbuildRun.cpp |
Emits stdio and RTT configuration with rebased filenames. |
tools/projmgr/schemas/common.schema.json |
Adds stdio definitions, legacy aliases, and RTT file properties. |
tools/projmgr/include/ProjMgrYamlParser.h |
Declares new YAML keys and parsing methods. |
tools/projmgr/include/ProjMgrWorker.h |
Updates processed debugger structures for stdio and RTT. |
tools/projmgr/include/ProjMgrRunDebug.h |
Renames collection and port helpers for stdio. |
tools/projmgr/include/ProjMgrParser.h |
Defines stdio and RTT data structures and defaults. |
Review effort: Balanced
Test Results 2 files 14 suites 11m 3s ⏱️ Results for commit 0b1bf15. ♻️ This comment has been updated with latest results. |
…n with documentation
brondani
force-pushed
the
projmgr-add-debugger-rtt
branch
from
November 17, 2026 21:27
cb3da03 to
0b1bf15
Compare
brondani
marked this pull request as ready for review
November 17, 2026 21:27
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #2713 +/- ##
==========================================
+ Coverage 87.57% 87.59% +0.02%
==========================================
Files 208 208
Lines 33748 33799 +51
==========================================
+ Hits 29554 29606 +52
+ Misses 4194 4193 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
edriouk
approved these changes
Nov 18, 2026
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.
Fixes
Documentation history
The documentation evolved before the corresponding schema and csolution back-end alignment addressed here:
telnetfile option was a singlefile, explicitly described as the output file's path and name.file-inandfile-out, still undertelnet.stdio. The accompanying pyOCD documentation retainedtelnetas a legacy alias and showed explicit input/output filenames.The same update added RTT channel mode
filewith per-channelfile-inandfile-out. RTT therefore remained a separate node;stdiowas one RTT channel mode, not a replacement forrtt.These documentation changes did not, by themselves, ensure alignment with the schema and csolution back end. This PR closes that gap; it is not merely a node rename.
Changes
stdioas the standard debugger I/O setting, retainingtelnetas a legacy input alias. When both are present,stdiotakes precedence.fileindependently; do not map it tofile-inorfile-out.file-inandfile-outfor stdio and RTT channels as complete filenames, including access-sequence expansion, path processing and cbuild-run output.Checklist