Skip to content

requirements: add pyocd #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

maska989
Copy link
Contributor

JIRA: CI-567

Description

Pyocd updated is version tag, and it is possible to use MCXN94x without development release.

Motivation and Context

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (refactoring, style fixes, git/CI config, submodule management, no code logic changes)

How Has This Been Tested?

  • Already covered by automatic testing.
  • New test added: (add PR link here).
  • Tested by hand on: arm8m33-mcxn84x-frdm.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing linter checks and tests passed.
  • My changes generate no new compilation warnings for any of the targets.

Special treatment

  • This PR needs additional PRs to work (list the PRs, preferably in merge-order).
  • I will merge this PR by myself when appropriate.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @maska989, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces pyocd as a new project dependency. This change is crucial for expanding hardware support, specifically enabling the use of MCXN94x devices, leveraging a recent update in pyocd's versioning that makes this possible outside of development releases.

Highlights

  • New Dependency: Added pyocd version 0.37.0 to the project's requirements.txt file. This addition is intended to enable support for MCXN94x devices, as pyocd's updated version tag now allows their use without requiring a development release.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds pyocd as a dependency, which is required for the MCXN94x target. I've added one comment regarding the sorting of dependencies in requirements.txt for better maintainability.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds pyocd as a new dependency to support the MCXN94x target. To improve maintainability, I've added a comment suggesting sorting the dependencies in requirements.txt.

@maska989 maska989 marked this pull request as draft July 23, 2025 13:54
@maska989 maska989 force-pushed the maska989/requirements_pyocd branch from c7bb9c7 to 30cbf21 Compare July 23, 2025 13:54
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds pyocd as a dependency to support the MCXN94x target. The change is straightforward and correct. I have one suggestion to improve the maintainability of the requirements.txt file by adding a comment to explain the purpose of this new dependency.

@@ -2,6 +2,7 @@ colorama==0.4.6
future==0.18.3
junitparser==3.1.2
pexpect==4.9.0
pyocd==0.37.0

Choose a reason for hiding this comment

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

medium

For better long-term maintainability, it's a good practice to add a comment explaining the purpose of a new dependency, especially when it's tied to specific hardware or functionality. This helps other developers understand why the dependency is needed without having to dig through git history.

Based on the pull request description, this dependency is for the MCXN94x target.

# For flashing/debugging MCXN94x targets
pyocd==0.37.0

Copy link

Unit Test Results

8 201 tests  ±0   7 677 ✅ ±0   41m 28s ⏱️ +3s
  479 suites ±0     524 💤 ±0 
    1 files   ±0       0 ❌ ±0 

Results for commit 30cbf21. ± Comparison against base commit 2a9738b.

@nalajcie
Copy link
Member

IMHO it's a host tool, not a trunner requirement (you're executing external program instead of importing some module). It would be better to add the host tool directly to the devel and gh-runner docker images.

We might also want to update the quickstart.

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.

2 participants