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

Draft: docs: guide for vscode esp-target setup #395

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

horw
Copy link
Member

@horw horw commented Feb 6, 2025

Description

This article explains how to set up the VSCode environment for correct file navigation across different target.

Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

@horw horw force-pushed the article/setup-vscode-to-make-idf-development-easy branch 2 times, most recently from abc0118 to 32dd0b5 Compare February 6, 2025 07:40
@horw
Copy link
Member Author

horw commented Feb 6, 2025

Still in progress, but overall, it will look like this.
@brianignacio5 @Kainarx Do you have any advice on how to improve it?

@horw horw force-pushed the article/setup-vscode-to-make-idf-development-easy branch 8 times, most recently from 97b2248 to 359ecaf Compare February 8, 2025 11:01
@horw horw force-pushed the article/setup-vscode-to-make-idf-development-easy branch from 359ecaf to f5673a7 Compare February 8, 2025 11:43
Copy link

github-actions bot commented Feb 8, 2025

🎉 A preview for this PR is available at: https://preview-developer.espressif.com/pr395/

Copy link
Contributor

@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.

I consider that having a single build directory is not a good ideas for most users. The c_cpp_properties.json can be defined on each project. The compiler path script could be executed in each project accordingly. You could also define a task in tasks.json to define this update script.

The issue with syntax highlight is that it relies on build files which should be a result of compilation. If you are relying on previous build files from other project it could lead to wrong headers too, since maybe IDF_TARGET is the same but other sdkconfig settings could diverge.

What is the target use case listed here?

How about consider a smaller build step like idf.py reconfigure to generate just the configuration step of CMake which generate compile_commands.json and config/sdkconfig.h

@f-hollow f-hollow added the Status: Draft Content writing in PR is not finished yet label Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Draft Content writing in PR is not finished yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants