Skip to content

[projmgr] Add debugger rtt nodes and stdio/telnet alias to align with documentation - #2713

Merged
brondani merged 1 commit into
mainfrom
projmgr-add-debugger-rtt
Nov 18, 2026
Merged

brondani merged 1 commit into
mainfrom
projmgr-add-debugger-rtt

Conversation

@brondani

Copy link
Copy Markdown
Collaborator

Fixes

Documentation history

The documentation evolved before the corresponding schema and csolution back-end alignment addressed here:

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

  • Add stdio as the standard debugger I/O setting, retaining telnet as a legacy input alias. When both are present, stdio takes precedence.
  • Preserve and emit legacy file independently; do not map it to file-in or file-out.
  • Support file-in and file-out for stdio and RTT channels as complete filenames, including access-sequence expansion, path processing and cbuild-run output.
  • For consistency across CMSIS tools, relative paths are resolved relative to the file containing the reference. When emitting cbuild-run, rebase paths relative to that output file so they continue to identify the same files.
  • Extend schema validation and add parser, schema and conversion tests for these options.

Checklist

  • 🤖 This change is covered by unit tests (if applicable).
  • 🤹 Manual testing has been performed (if necessary).
  • 🛡️ Security impacts have been considered (if relevant).
  • 📖 Documentation updates are complete (if required).
  • 🧠 Third-party dependencies and TPIP updated (if required).

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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 stdio with precedence over the legacy telnet input alias, while preserving legacy file independently.
  • 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

@github-actions

github-actions Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Test Results

    2 files     14 suites   11m 3s ⏱️
  506 tests   506 ✅ 0 💤 0 ❌
1 012 runs  1 012 ✅ 0 💤 0 ❌

Results for commit 0b1bf15.

♻️ This comment has been updated with latest results.

@brondani
brondani force-pushed the projmgr-add-debugger-rtt branch from cb3da03 to 0b1bf15 Compare November 17, 2026 21:27
@brondani
brondani marked this pull request as ready for review November 17, 2026 21:27
@brondani
brondani requested review from edriouk and jkrech November 17, 2026 21:27
@codecov

codecov Bot commented Nov 17, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 99.09091% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 87.59%. Comparing base (92918b8) to head (0b1bf15).

Files with missing lines Patch % Lines
tools/projmgr/src/ProjMgrRunDebug.cpp 96.77% 1 Missing ⚠️
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     
Flag Coverage Δ
projmgr-cov 95.25% <99.09%> (+0.03%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
tools/projmgr/include/ProjMgrParser.h 100.00% <ø> (ø)
tools/projmgr/include/ProjMgrRunDebug.h 100.00% <ø> (ø)
tools/projmgr/include/ProjMgrWorker.h 90.62% <ø> (ø)
tools/projmgr/src/ProjMgrCbuildRun.cpp 99.28% <100.00%> (+0.05%) ⬆️
tools/projmgr/src/ProjMgrWorker.cpp 94.51% <100.00%> (+0.03%) ⬆️
tools/projmgr/src/ProjMgrYamlParser.cpp 91.90% <100.00%> (+0.13%) ⬆️
tools/projmgr/src/ProjMgrRunDebug.cpp 97.73% <96.77%> (+0.02%) ⬆️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@brondani
brondani merged commit 692da7e into main Nov 18, 2026
26 checks passed
@brondani
brondani deleted the projmgr-add-debugger-rtt branch November 18, 2026 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants