-
Notifications
You must be signed in to change notification settings - Fork 7.5k
docs: add missing Git long paths and PowerShell Core prerequisites #44372
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
base: main
Are you sure you want to change the base?
docs: add missing Git long paths and PowerShell Core prerequisites #44372
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds two missing prerequisite sections to the PowerToys developer documentation: enabling Git long path support and installing PowerShell Core. These additions help ensure contributors have the proper environment configuration before attempting to build the project.
Key changes:
- Added instructions for enabling Git long paths with the required system configuration command
- Added PowerShell Core installation guidance with verification instructions
doc/devdocs/readme.md
Outdated
| ```md |
Copilot
AI
Dec 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code block is not properly closed. There are extra blank lines (94-96) and an incorrect closing syntax. The closing should be three backticks on line 94 without the "md" tag. Line 97 incorrectly starts with ```md which appears to be a malformed attempt to start a new section.
| ```md |
| ```powershell | ||
| pwsh --version | ||
Copilot
AI
Dec 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code block is not properly closed. There are extra blank lines (110-113) after the command. The closing backticks should be on line 111 without any blank lines in between.
|
|
||
| #### Enable Git long paths (Windows) | ||
|
|
||
| In addition to enabling long paths in Windows, Git must also be configured to support long paths. |
Copilot
AI
Dec 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdown files in this repository should wrap at 80 characters. This line exceeds that limit. Consider breaking it into multiple lines.
doc/devdocs/readme.md
Outdated
| ```md | ||
| #### PowerShell Core (pwsh) | ||
| Some PowerToys build scripts rely on **PowerShell Core** (`pwsh`). |
Copilot
AI
Dec 20, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdown files in this repository should wrap at 80 characters. This line exceeds that limit. Consider breaking it into multiple lines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot open a new pull request to apply changes based on this feedback
|
@microsoft-github-policy-service agree |
This comment has been minimized.
This comment has been minimized.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This comment has been minimized.
This comment has been minimized.
|
Hi! This is a false positive. longpaths is the required technical keyword for the Git configuration command and cannot be changed." |
jiripolasek
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The markdown syntax for the new content is invalid, causing the document to be broken :(
|
Hi @Muthusrihemadharshini, Before merging the change, it needs to pass the spellchecker. If there are false positives, resolve them by following the bot’s instructions: https://docs.check-spelling.dev/Accepting-Suggestions |
|
Hi @jiripolasek, thank you for the review! I apologise for the syntax error. I will fix the Markdown formatting and resolve the spellchecker false positive by following the bot's instructions right away. Thank you for your patience as I learn the project's standards |
…uthusrihemadharshini/PowerToys into docs-add-missing-prerequisites
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Hi @jiripolasek, I have completed the requested changes. I've updated the Markdown formatting to fix the syntax and resolved the spelling errors flagged by the bot. The workflows are now ready for approval to finish the final checks. Thank you! |
|
The name PowerShell Core does not exist any more. We should not be referring to it in any build documentation. PowerShell Core is now just "PowerShell". Some of the CI build steps do invoke As for the git long paths support, I can build without it. Have you confirmed this, too? In general, we should not be updating the build requirements without proof that each of the steps are actually pre-requisites. I don't think this verification step has been performed on the original issue yet. |
|
@daverayment Thank you for the detailed feedback — this is very helpful. You’re absolutely right about the naming; I’ll avoid referring to “PowerShell Core” and instead use the current “PowerShell” terminology. Before proposing any updates to the build prerequisites, I’ll verify the following: whether pwsh is required for a standard Visual Studio developer build, or only for CI / packaging / signing workflows whether Git long path support is truly required or only applicable in specific scenarios I’ll follow up once I’ve confirmed this with concrete validation steps or references, so we’re only documenting requirements that are strictly necessary. |
Summary of the Pull Request
This PR adds essential missing steps to the Prerequisites for Compiling PowerToys section in the DevDocs. It ensures that contributors are aware they must enable Git long path support and install PowerShell Core (pwsh) before attempting to build the project.
PR Checklist
Closes: #43444
Communication: I've discussed this in the issue tracker.
Dev docs: Added/updated
Detailed Description of the Pull Request / Additional comments
The current doc/devdocs/readme.md was missing two critical environment setup steps:
Git Long Paths: Added the command git config --system core.longpaths true.
PowerShell Core: Added a link to the official Microsoft installation guide and a command to verify the installation (pwsh --version).
Validation Steps Performed
Manual Validation: Verified Markdown rendering in VS Code.
Command Verification: Verified commands are accurate for Windows environments.