mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-08-29 10:09:43 +02:00
## Summary Migrate `deps/spdlog` from a git submodule to **vcpkg manifest mode** with an overlay port pinned to the **exact same commit** (`gabime/spdlog@616866fc`). Replaces the polyfill shim added in #47910 with a proper port-level patch. This is the follow-up to PR #47928, which I closed after @zadjii-msft / @DHowett clarified that the intended direction was a single combined "move to vcpkg **and** apply a patch file" (one change, not two stepping stones). ## Guidance honored Per @zadjii-msft (offline): - ✅ Convert each submodule to vcpkg **one at a time** — this PR is **spdlog only**. `deps/expected-lite` stays a submodule (separate PR next). - ✅ Atomic commit per dep (multiple commits on the branch for review traceability; squash on merge gives the requested single commit). - ✅ **Don't bump the version.** Only variable changed: submodule → vcpkg. Same commit (`616866fc`, v1.8.5 + 38) the submodule pointed at. Per @DHowett ([review](https://github.com/microsoft/PowerToys/pull/48039#pullrequestreview-4338835150)): - ✅ No vcpkg submodule — vswhere-first detection via a Terminal-style `steps-install-vcpkg.yml` template; three-tier `VcpkgRoot` fallback (env var → VS-shipped → runtime clone pinned to manifest baseline). ## Design - **Repo-root manifest**: `vcpkg.json` declares only `spdlog`, with `builtin-baseline` pinned. `vcpkg-configuration.json` registers `deps/vcpkg-overlays/` as overlay-ports. - **Overlay port** `deps/vcpkg-overlays/spdlog/`: `vcpkg_from_github(REF 616866fc...)` with bundled fmt preserved (`-DSPDLOG_FMT_EXTERNAL=OFF`); the MSVC 14.51 fix from #47910 carried as a proper vcpkg patch on `include/spdlog/fmt/bundled/format.h`. - **vcpkg integration is global** (set in `Cpp.Build.props`, imported via `ForceImportBeforeCppProps` for every `.vcxproj`). An earlier attempt to make vcpkg per-project-opt-in via `deps/spdlog.props` failed because ~85 PowerToys `.vcxproj` files import `spdlog.props` AFTER `Microsoft.Cpp.targets`, by which point `vcpkg.props`' `ClCompile` hook is dead-on-arrival. The trade-off (every C++ project invokes `vcpkg install` once at build time, ~0.5 s on cache hits, manifest declares only spdlog so install set is fixed) is documented in the expanded `Cpp.Build.props` comment. - **`deps/spdlog.props`** is now a thin shim that only sets the historical `SPDLOG_*` preprocessor defines for source-compat. - **`Cpp.Build.targets`** is a new file imported via `ForceImportAfterCppTargets` to load `vcpkg.targets` after `Microsoft.Cpp.targets`. A fail-fast `<Target>` errors with a clear message if `vcpkg.props` can't be found at the resolved `VcpkgRoot`. - **Removes** `deps/spdlog-msvc-fix/` polyfill, in-tree wrapper `src/logging/`, spdlog submodule, the single `<ProjectReference>` in `logger.vcxproj`, plus 3 `.slnf` refs and 2 `.slnx` refs (`PowerToys.slnx` + `installer/PowerToysSetup.slnx`), plus 3 hard-coded `..\deps\spdlog\include` entries in `<AdditionalIncludeDirectories>`. - **CI**: new reusable `.pipelines/v2/templates/steps-install-vcpkg.yml` (vswhere-first, manifest-baseline-pinned fallback clone, respects `useVSPreview`). Gated `Cache@2` for `%LOCALAPPDATA%\vcpkg\archives` keyed on overlay-port contents. Same vcpkg detection added to `tools\build\build-essentials.ps1` for local devs. ## Verification Local build matrix (all 4 configs of `logger.vcxproj` and a representative late-import consumer): | Config | Result | Notes | |--------|--------|-------| | Release \| x64 | ✅ | vcpkg install ~21 s, `logger.lib` produced | | Debug \| x64 | ✅ | **Validates patch fixes the actual MSVC 14.51 bug** (`_ITERATOR_DEBUG_LEVEL > 0` → `_SECURE_SCL`) | | Release \| ARM64 | ✅ | vcpkg cross-installs `arm64-windows-static` spdlog in ~16 s | | Debug \| ARM64 | ✅ | **Previously DISABLED for the in-tree spdlog** (per `<Build Solution="Debug\|ARM64" Project="false" />` in `PowerToysSetup.slnx`); this migration FIXES that latent gap | | FancyZonesLib (Release \| x64) | ✅ | Late-import-pattern consumer; previously broke in v2 | Full PowerToys CI (x64 + arm64 + CmdPal SDK + all GitHub Actions checks) green. **Consumer audit**: 72 `.vcxproj` files reference `logger.vcxproj`; all 72 also import `deps/spdlog.props`. No transitive-link breakage. ## Out of scope (intentional) - `deps/expected-lite` migration — next PR per "one-at-a-time" rule. - Remote vcpkg binary cache (Azure Artifacts NuGet feed). Local pipeline `Cache@2` works for now, but a remote feed survives across pipelines and is the long-term answer. Happy to split this into a follow-up. ## Notes for review - Patch in the overlay port is identical content to PR #47928's patch but regenerated with LF line endings (vcpkg's `vcpkg_apply_patches` is strict; no `--ignore-whitespace`). - Once PowerToys eventually bumps spdlog past v1.14 (which ships fmt 10.2 and drops the affected code path), the overlay port can be deleted and we can use upstream vcpkg's `spdlog` directly. - Re. official-release pipelines and terrapin / less-restricted network isolation: VS-shipped vcpkg is the primary path (no network); the fallback clone is only exercised when VS doesn't ship vcpkg. Happy to wire terrapin into the fallback as a follow-up if the official build template needs it. Closes the work tracked in #47928 (which was closed unmerged). --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Dustin L. Howett <dustin@howett.net>
378 lines
6.6 KiB
Plaintext
378 lines
6.6 KiB
Plaintext
## Ignore Visual Studio temporary files, build results, and
|
|
## files generated by popular Visual Studio add-ons.
|
|
##
|
|
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
|
|
|
|
# User-specific files
|
|
*.suo
|
|
*.user
|
|
*.userosscache
|
|
*.sln.docstates
|
|
|
|
# User-specific files (MonoDevelop/Xamarin Studio)
|
|
*.userprefs
|
|
|
|
# Build results
|
|
[Dd]ebug/
|
|
[Dd]ebugPublic/
|
|
[Rr]elease/
|
|
[Rr]eleases/
|
|
x64/
|
|
x86/
|
|
ARM64/
|
|
bld/
|
|
[Bb]in/
|
|
[Oo]bj/
|
|
[Ll]og/
|
|
|
|
# Visual Studio 2015/2017 cache/options directory
|
|
.vs/
|
|
# Uncomment if you have tasks that create the project's static files in wwwroot
|
|
#wwwroot/
|
|
|
|
# Visual Studio 2017 auto generated files
|
|
Generated\ Files/
|
|
|
|
Generated/
|
|
|
|
# MSTest test Results
|
|
[Tt]est[Rr]esult*/
|
|
[Bb]uild[Ll]og.*
|
|
|
|
# NUNIT
|
|
*.VisualState.xml
|
|
TestResult.xml
|
|
|
|
# Build Results of an ATL Project
|
|
[Dd]ebugPS/
|
|
[Rr]eleasePS/
|
|
dlldata.c
|
|
|
|
# Benchmark Results
|
|
BenchmarkDotNet.Artifacts/
|
|
|
|
# .NET Core
|
|
project.lock.json
|
|
project.fragment.lock.json
|
|
artifacts/
|
|
**/Properties/launchSettings.json
|
|
|
|
# StyleCop
|
|
StyleCopReport.xml
|
|
|
|
# Files built by Visual Studio
|
|
*_i.c
|
|
*_p.c
|
|
*_i.h
|
|
*.ilk
|
|
*.meta
|
|
*.obj
|
|
*.iobj
|
|
*.pch
|
|
*.pdb
|
|
*.ipdb
|
|
*.pgc
|
|
*.pgd
|
|
*.rsp
|
|
*.sbr
|
|
*.tlb
|
|
*.tli
|
|
*.tlh
|
|
*.tmp
|
|
*.tmp_proj
|
|
*.log
|
|
*.vspscc
|
|
*.vssscc
|
|
.builds
|
|
*.pidb
|
|
*.svclog
|
|
*.scc
|
|
|
|
# Chutzpah Test files
|
|
_Chutzpah*
|
|
|
|
# Visual C++ cache files
|
|
ipch/
|
|
*.aps
|
|
*.ncb
|
|
*.opendb
|
|
*.opensdf
|
|
*.sdf
|
|
*.cachefile
|
|
*.VC.db
|
|
*.VC.VC.opendb
|
|
|
|
# Visual Studio profiler
|
|
*.psess
|
|
*.vsp
|
|
*.vspx
|
|
*.sap
|
|
|
|
# Visual Studio Trace Files
|
|
*.e2e
|
|
|
|
# TFS 2012 Local Workspace
|
|
$tf/
|
|
|
|
# Guidance Automation Toolkit
|
|
*.gpState
|
|
|
|
# ReSharper is a .NET coding add-in
|
|
_ReSharper*/
|
|
*.[Rr]e[Ss]harper
|
|
*.DotSettings.user
|
|
|
|
# JustCode is a .NET coding add-in
|
|
.JustCode
|
|
|
|
# TeamCity is a build add-in
|
|
_TeamCity*
|
|
|
|
# DotCover is a Code Coverage Tool
|
|
*.dotCover
|
|
|
|
# AxoCover is a Code Coverage Tool
|
|
.axoCover/*
|
|
!.axoCover/settings.json
|
|
|
|
# Visual Studio code coverage results
|
|
*.coverage
|
|
*.coveragexml
|
|
|
|
# NCrunch
|
|
_NCrunch_*
|
|
.*crunch*.local.xml
|
|
nCrunchTemp_*
|
|
|
|
# MightyMoose
|
|
*.mm.*
|
|
AutoTest.Net/
|
|
|
|
# Web workbench (sass)
|
|
.sass-cache/
|
|
|
|
# Installshield output folder
|
|
[Ee]xpress/
|
|
|
|
# DocProject is a documentation generator add-in
|
|
DocProject/buildhelp/
|
|
DocProject/Help/*.HxT
|
|
DocProject/Help/*.HxC
|
|
DocProject/Help/*.hhc
|
|
DocProject/Help/*.hhk
|
|
DocProject/Help/*.hhp
|
|
DocProject/Help/Html2
|
|
DocProject/Help/html
|
|
|
|
# Click-Once directory
|
|
publish/
|
|
|
|
# Publish Web Output
|
|
*.[Pp]ublish.xml
|
|
*.azurePubxml
|
|
# Note: Comment the next line if you want to checkin your web deploy settings,
|
|
# but database connection strings (with potential passwords) will be unencrypted
|
|
*.pubxml
|
|
*.publishproj
|
|
|
|
# Microsoft Azure Web App publish settings. Comment the next line if you want to
|
|
# checkin your Azure Web App publish settings, but sensitive information contained
|
|
# in these scripts will be unencrypted
|
|
PublishScripts/
|
|
|
|
# NuGet Packages
|
|
*.nupkg
|
|
# The packages folder can be ignored because of Package Restore
|
|
**/[Pp]ackages/*
|
|
# except build/, which is used as an MSBuild target.
|
|
!**/[Pp]ackages/build/
|
|
# Uncomment if necessary however generally it will be regenerated when needed
|
|
#!**/[Pp]ackages/repositories.config
|
|
# NuGet v3's project.json files produces more ignorable files
|
|
*.nuget.props
|
|
*.nuget.targets
|
|
|
|
# Microsoft Azure Build Output
|
|
csx/
|
|
*.build.csdef
|
|
|
|
# Microsoft Azure Emulator
|
|
ecf/
|
|
rcf/
|
|
|
|
# Windows Store app package directories and files
|
|
AppPackages/
|
|
BundleArtifacts/
|
|
Package.StoreAssociation.xml
|
|
_pkginfo.txt
|
|
*.appx
|
|
|
|
# Visual Studio cache files
|
|
# files ending in .cache can be ignored
|
|
*.[Cc]ache
|
|
# but keep track of directories ending in .cache
|
|
!*.[Cc]ache/
|
|
|
|
# Others
|
|
ClientBin/
|
|
~$*
|
|
*~
|
|
*.dbmdl
|
|
*.dbproj.schemaview
|
|
*.jfm
|
|
*.pfx
|
|
*.publishsettings
|
|
orleans.codegen.cs
|
|
|
|
# Including strong name files can present a security risk
|
|
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
|
|
#*.snk
|
|
|
|
# Since there are multiple workflows, uncomment next line to ignore bower_components
|
|
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
|
|
#bower_components/
|
|
|
|
# RIA/Silverlight projects
|
|
Generated_Code/
|
|
|
|
# Backup & report files from converting an old project file
|
|
# to a newer Visual Studio version. Backup files are not needed,
|
|
# because we have git ;-)
|
|
_UpgradeReport_Files/
|
|
Backup*/
|
|
UpgradeLog*.XML
|
|
UpgradeLog*.htm
|
|
ServiceFabricBackup/
|
|
*.rptproj.bak
|
|
|
|
# SQL Server files
|
|
*.mdf
|
|
*.ldf
|
|
*.ndf
|
|
|
|
# Business Intelligence projects
|
|
*.rdl.data
|
|
*.bim.layout
|
|
*.bim_*.settings
|
|
*.rptproj.rsuser
|
|
|
|
# Microsoft Fakes
|
|
FakesAssemblies/
|
|
|
|
# GhostDoc plugin setting file
|
|
*.GhostDoc.xml
|
|
|
|
# Node.js Tools for Visual Studio
|
|
.ntvs_analysis.dat
|
|
node_modules/
|
|
|
|
# Visual Studio 6 build log
|
|
*.plg
|
|
|
|
# Visual Studio 6 workspace options file
|
|
*.opt
|
|
|
|
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
|
|
*.vbw
|
|
|
|
# Visual Studio LightSwitch build output
|
|
**/*.HTMLClient/GeneratedArtifacts
|
|
**/*.DesktopClient/GeneratedArtifacts
|
|
**/*.DesktopClient/ModelManifest.xml
|
|
**/*.Server/GeneratedArtifacts
|
|
**/*.Server/ModelManifest.xml
|
|
_Pvt_Extensions
|
|
|
|
# Paket dependency manager
|
|
.paket/paket.exe
|
|
paket-files/
|
|
|
|
# FAKE - F# Make
|
|
.fake/
|
|
|
|
# JetBrains Rider
|
|
.idea/
|
|
*.sln.iml
|
|
|
|
# CodeRush
|
|
.cr/
|
|
|
|
# Python Tools for Visual Studio (PTVS)
|
|
__pycache__/
|
|
*.pyc
|
|
|
|
# Cake - Uncomment if you are using it
|
|
# tools/**
|
|
# !tools/packages.config
|
|
ImageResizer/tools/**
|
|
!ImageResizer/tools/packages.config
|
|
|
|
# Tabs Studio
|
|
*.tss
|
|
|
|
# Telerik's JustMock configuration file
|
|
*.jmconfig
|
|
|
|
# BizTalk build output
|
|
*.btp.cs
|
|
*.btm.cs
|
|
*.odx.cs
|
|
*.xsd.cs
|
|
|
|
# OpenCover UI analysis results
|
|
OpenCover/
|
|
|
|
# Azure Stream Analytics local run output
|
|
ASALocalRun/
|
|
|
|
# MSBuild Binary and Structured Log
|
|
*.binlog
|
|
|
|
# NVidia Nsight GPU debugger configuration file
|
|
*.nvuser
|
|
|
|
# MFractors (Xamarin productivity tool) working folder
|
|
.mfractor/
|
|
|
|
# Temp build files
|
|
src/settings/settings-html/200.html
|
|
src/settings/settings-html/404.html
|
|
|
|
# Temp telemetry files.
|
|
src/common/Telemetry/*.etl
|
|
|
|
# Don't ignore MergeModules
|
|
!**/MergeModules/Release/
|
|
!**/MergeModules/Debug/
|
|
/src/modules/previewpane/SvgThumbnailProvider/$(SolutionDir)$(Platform)/$(Configuration)/modules/FileExplorerPreview/SvgThumbnailProvider.xml
|
|
/src/modules/powerrename/ui/RCa24464
|
|
/src/modules/powerrename/ui/RCb24464
|
|
|
|
# Generated installer file for Monaco source files.
|
|
/installer/PowerToysSetupVNext/MonacoSRC.wxs
|
|
|
|
# MSBuildCache
|
|
/MSBuildCacheLogs/
|
|
|
|
# PowerToys Settings generated search index (legacy location) and obj outputs
|
|
/src/settings-ui/Settings.UI/Assets/Settings/search.index.json
|
|
|
|
# PowerToysInstaller Build Temp Files
|
|
installer/*/*.wxs.bk
|
|
/src/modules/awake/.claude
|
|
|
|
# Claude AI local settings - local-only, not committed
|
|
**/.claude/settings.local.json
|
|
|
|
# Squad / Copilot agents — local-only, not committed
|
|
.copilot
|
|
.squad
|
|
.squad-workstream
|
|
.github/agents/**squad**.md
|
|
.github/workflows/**squad**.yml
|
|
|
|
# vcpkg manifest mode installed packages
|
|
vcpkg_installed/
|
|
|
|
deps/vcpkg/
|