-
Notifications
You must be signed in to change notification settings - Fork 9.1k
doc, tools: Improve docs around using clang-format with VS #9782
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
Conversation
generation of a clang-format.exe when using VisualStudio
zadjii-msft
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.
This is true, but it's not technically the most correct guidance here. Technically, all you need to do is a nuget restore to get clang-format pulled down onto your machine. Those mentioned commands will work, but only because they're also calling nuget restore 😄
|
I see, would adding a step where the user only executes
Import-Module .\tools\OpenConsole.psm1
Set-MsBuildDevEnvironment
Get-CodeFormat
|
Yea great idea, that all looks good to me! |
updated the documentation accordingly.
zadjii-msft
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.
Thanks!
| Export-ModuleMember -Function Set-MsbuildDevEnvironment,Invoke-OpenConsoleTests,Invoke-OpenConsoleBuild,Start-OpenConsole,Debug-OpenConsole,Invoke-CodeFormat,Invoke-XamlFormat,Verify-XamlFormat | ||
| #.SYNOPSIS | ||
| # Download clang-format.exe required for code formatting | ||
| function Get-Format() |
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.
I'm not in love with the exposed member name here, but... this will be fine. Get- isn't totally correct for what this does; it's more of an Install-
Summary of the Pull Request
Commit dbbe820 seems to change where OpenConsole.psm1 puts clang-format.exe but /doc/building.md still uses the path from commit 9b92986.
Updated clang-format.exe's path and added the required steps to generate a clang-format.exe file.
References
PR Checklist