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

[documentation] Wrong and breaking info for adding Windows PATH for CLI and pio functionality #370

Open
eabase opened this issue Nov 29, 2024 · 0 comments

Comments

@eabase
Copy link

eabase commented Nov 29, 2024

Issue on your documentation page for installing shell commands:

There you say:

You need to edit the system environment variable called Path and append C:\Users\UserName\.platformio\penv\Scripts\ path in the beginning of a list...

The content of that location is:

.\penv\Scripts\
├── __pycache__
│   ├── bottle.cpython-311.pyc
│   └── readelf.cpython-311.pyc
├── Activate.ps1
├── activate
├── activate.bat
├── async-json-rpc-server.exe
├── bottle.exe
├── bottle.py
├── deactivate.bat
├── normalizer.exe
├── pio.exe
├── piodebuggdb.exe
├── pip.exe
├── pip3.11.exe
├── pip3.exe
├── platformio.exe
├── pyserial-miniterm.exe
├── pyserial-ports.exe
├── python.exe
├── pythonw.exe
├── readelf.py
├── tabulate.exe
└── uvicorn.exe

There are 3 serious issues with this PATH:

  1. You are adding to Windows SYSTEM PATH and not USER PATH, which may break all sort of already installed tools and programs, including Python interpreter.

  2. You are telling user to put the PATH addition on the top of the path list, (again) overriding all other PATHs.

  3. There are only 3 programs needed, so why are you asking user to add entire directory?
    That include an outdated Python interpreter, and several unknown executables!?

NOTE:
platformio.exe and pio.exe are the same file.

@ivankravets ivankravets transferred this issue from platformio/platformio-core Nov 29, 2024
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

No branches or pull requests

1 participant