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

Powershell export (AUD-5758) #1292

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Dennis40816
Copy link

@Dennis40816 Dennis40816 commented Oct 11, 2024

Description

When using PowerShell to execute export.bat, the environment variable cannot be correctly set and exported to the current terminal. In September 2024, ESP-IDF introduced export.ps1 for PowerShell users. If ESP-ADF could also provide an export.ps1 script, it would greatly enhance the convenience for PowerShell users when setting up ESP-ADF.

Therefore, the following changes were made in this PR:

  • Added export.ps1, which internally calls the export.ps1 from ESP-IDF.
  • Modified docs\en\get-started\index.rst.

Screenshots

  • using export.bat in PowerShell failed to properly set the environment variables, resulting in idf.py not being found
  • using export.ps1 in PowerShell allows the environment variables to be set correctly, making idf.py accessible

Related

Testing


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.

@github-actions github-actions bot changed the title Powershell export Powershell export (AUD-5758) Oct 11, 2024
@jason-mao
Copy link
Collaborator

@Dennis40816 Well done, and thank you for your contribution.

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