Skip to content
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

Enhance/openocd troubleshooting #1137

Merged
merged 4 commits into from
Mar 5, 2024
Merged

Conversation

radurentea
Copy link
Collaborator

Description

Added Troubleshooting link for OpenOCD errors.

Task: https://jira.espressif.com:8443/browse/VSC-1237

Type of change

  • Enhancement

Steps to test this pull request

Provide a list of steps to test changes in this PR and required output

  1. Open Project
  2. Take actions that would trigger an OpenOCD error.
  • Expected behaviour:

After error message in the "ESP-IDF" output channel, there should be a new line added with the following text:

For assistance with OpenOCD errors, please refer to our Troubleshooting FAQ: https://github.com/espressif/openocd-esp32/wiki/Troubleshooting-FAQ.

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Tested on Windows 11. Tried to run OpenOCD without setting up the project.

Test Configuration:

  • ESP-IDF Version: master
  • OS (Windows,Linux and macOS): Windows 11

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Initial implementation was not covering multiple errors, the user would have gotten spammed with troubleshooting links
Copy link

Download the artifacts for this pull request:

Copy link
Collaborator

@brianignacio5 brianignacio5 left a comment

Choose a reason for hiding this comment

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

LGTM

@AndriiFilippov
Copy link
Collaborator

@radurentea hi!

Tested under:

OS - Windows 10
ESP-IDF: v5.1.2

Able to see message and open the link

image

LGTM 👍

@radurentea radurentea merged commit daf4054 into master Mar 5, 2024
6 checks passed
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