Update WindowsPort.md as per #129 and other advisories #130

citkane · 2025-08-05T12:47:30Z

Make users aware that cloning into a parent git repository can cause failure.
Make users aware that having "C++ Clang Tools for Windows" installed may cause build failure and offer a workaround in the Webkit Command Prompt script.
As per Windows port documentation errata for choco install cmake #129, choco installs Cmake 4+ by default since ~March 2025. This causes downstream issues with vcpkg woff2. Use Cmake 3.23 instead.
Add option to set ccmake for pch in the Webkit Command Prompt

- Make users aware that shallow cloning of the WebKit repo will cause failure - Make users aware that "C++ Clang Tools for Windows" will cause build failure and offer workaround in the Webkit Command Prompt script. - Add option to set ccmake for pch in the Webkit Command Prompt

donny-dont

Overall looks good just some follow ups for you and we can squash and land

docs/Ports/WindowsPort.md

donny-dont · 2025-08-13T16:49:03Z

docs/Ports/WindowsPort.md


 Install CMake, Perl, Python, Ruby, gperf \([GnuWin32 Gperf](https://gnuwin32.sourceforge.net/packages/gperf.htm)\), LLVM, and Ninja.
-Python 3.12 has [a problem for WebKit at the moment](https://webkit.org/b/261113). Use Python 3.11.
+- Python 3.12 has [a problem for WebKit at the moment](https://webkit.org/b/261113). Use Python 3.11.


I’m not 100% sure this is still an issue and I’m not sure if Python 3.13 is good to use. Might be worth verifying this.

Python 3.13 (latest choco) compiles WebKit for me with the following caveates:

I did not flush ccache or __pycache__

I am not building or running any tests

I am only building Release

While choco install python311 works, it is no longer on the Chocolately package list. I don't really understand the underlying issue at a low level to make a call on this, but maybe the documentation should advise to do choco install python --version=3.11.x only if problems are experienced?

I’m not sure if that works because you can have multiple python versions installed

@iangrunert any thoughts on this?

I'm using Python 3.12 and haven't ran into issues as of yet.

From CMake configure: -- Found Python: C:/Python313/python.exe (found version "3.13.6") found components: Interpreter

I think this is hard-coded somewhere obfuscated to PATH. I tried setting the PYTHON env variable to something else from the WebKit shell script, and it got overwritten. Chocolately should however fix PATH to whatever version is installed last, even though multiple version remain on disk.

Let me know if we are good with 3.13.x. If so, we can just document python for choco install.

@iangrunert @donny-dont
Have you reached any conclusion on how to document Python?

docs/Ports/WindowsPort.md

donny-dont · 2025-08-13T16:51:24Z

docs/Ports/WindowsPort.md


 You can use [Chocolatey](https://community.chocolatey.org/) to install the tools.
 [ActivePerl chocolatey package](https://community.chocolatey.org/packages/ActivePerl) has a problem and no package maintainer now.
 XAMPP includes Perl, and running layout tests needs XAMPP. Install XAMPP instead.

 ```
-choco install -y xampp-81 python311 ruby git cmake gperf llvm ninja
+choco install -y xampp-81 python311 ruby git gperf llvm ninja
+choco install -y cmake --version=3.31.8


I think we need a choco pin command with this so when someone upgrades they don’t end up with CMake 4. Ideally the version could be <4.0.0 so if there is another 3.x release it’ll upgrade.

See revised

donny-dont

@iangrunert any other suggestions for this?

donny-dont · 2025-08-13T22:25:40Z

docs/Ports/WindowsPort.md

+# Use the latest 3.x version of cmake available
+choco search -e cmake -a
+choco install -y cmake --version=3.x.x
+choco pin add -n=cmake


I’m not chocolatey expert would this work if a new 3.x.x is released and update is called?

I think that pin means pin, but we can be more helpful with the message (see update)

docs/Ports/WindowsPort.md

Add patch fix for CMake complications with woff2

citkane · 2025-08-28T19:03:27Z

docs/Ports/WindowsPort.md

+
+rem Vcpkg cannot install woff2 with CMake 4+
+rem Apply the patch below to force vcpkg to the VS toolchain bundled version of CMake 3
+rem The WebKit build will still use the CMake on your PATH
+rem (
+rem echo diff --git a/WebKitLibraries/triplets/x64-windows-webkit.cmake b/WebKitLibraries/triplets/x64-windows-webkit.cmake
+rem echo index 502577b9fe..b06fdcdbda 100644
+rem echo --- a/WebKitLibraries/triplets/x64-windows-webkit.cmake
+rem echo +++ b/WebKitLibraries/triplets/x64-windows-webkit.cmake
+rem echo @@ -1,3 +1,5 @@
+rem echo +set^(VCPKG_ENV_PASSTHROUGH DevEnvDir^)
+rem echo +set^(CMAKE_COMMAND "$ENV{DevEnvDir}CommonExtensions/Microsoft/CMake/CMake/bin/cmake.exe"^)
+rem echo  set^(VCPKG_TARGET_ARCHITECTURE x64^)
+rem echo  set^(VCPKG_CRT_LINKAGE dynamic^)
+rem echo  set^(VCPKG_LIBRARY_LINKAGE dynamic^)
+rem ) > triplet.patch
+rem git apply --whitespace=nowarn triplet.patch 2>nul
+rem del triplet.patch
+


This patches the triplet file to force vcpkg to use the VS toolchain version of CMake 3.

It is potentially fragile, but I think it beats all the messing with the devs build environment outside of the project scope.

Apologies for the flip flop...
This mixed mode CMake build failed on me overnight. See the comment below for a more robust approach.

docs/Ports/WindowsPort.md

Mixed CMake with patch build fails. Force PATH to bundled CMake 3.x instead.

citkane · 2025-08-29T10:50:31Z

docs/Ports/WindowsPort.md

+rem Set PATH to use the VS toolchain bundled CMake 3.x. This ensures that downstream vcpkg builds will succeed.
+path %DevEnvDir%CommonExtensions\\Microsoft\\CMake\\CMake\\bin;%path%
+


Instead of forcing CMake 3.x in the developers global ENV, use the VS 2022 bundled CMake 3.x for the project build.

citkane · 2025-08-29T10:55:42Z

docs/Ports/WindowsPort.md

@@ -1,35 +1,42 @@
 # Windows port

-It is using [cairo](https://www.cairographics.org/) for the graphics backend, [libcurl](https://curl.se/libcurl/) for the network backend.
+It is using [skia](https://skia.org/) for the graphics backend, [libcurl](https://curl.se/libcurl/) for the network backend.


Am I right that skia is now the default?

Yep, Skia is the default.

Housekeeping, formatting, semantics and update to consider VCPKG build in recent WebKit versions.

citkane · 2025-08-29T13:25:42Z

docs/Ports/WindowsPort.md

+Recent WebKit versions will use [VCPKG](https://vcpkg.io) to build the required libraries.

+Older versions will automatically download required libraries from [WebKitRequirements](https://github.com/WebKitForWindows/WebKitRequirements) when you perform a `build-webkit`.
+It checks the latest WebKitRequirements every time, so it is recommended to use `--skip-library-update` for incremental builds to speed up the next time.
 ```
 python Tools\Scripts\update-webkit-win-libs.py
 perl Tools\Scripts\build-webkit --release --skip-library-update
 ```


@iangrunert @donny-dont
Are you OK with how this documents the change to VCPKG builds?

I'd probably link the commit where vcpkg was introduced https://commits.webkit.org/295042@main

Over time it'll get less likely someone is trying to build WebKit from a hash before that landed in May.

citkane · 2025-08-29T13:26:44Z

docs/Ports/WindowsPort.md

+rem Set these for older versions that do not use VCPKG for library building
 rem set WEBKIT_LIBRARIES=%~dp0WebKitLibraries\win
-path %~dp0WebKitLibraries\win\bin;%path%
+rem path %~dp0WebKitLibraries\win\bin;%path%


Am I correct that these are no longer required for VCPKG build scenarios?

Correct - WebKitLibraries was used for the old library downloading mechanism.

citkane · 2025-08-29T13:30:24Z

A successful build using the strategy in "WebKit command prompt" to prefix PATH with the VS bundled CMake 3.x: build.log

@iangrunert @donny-dont
I am fairly happy that the documentation for Windows build reads better, works and is up to date. Would you give it another peruse when you have a chance. Note that I have NOT ventured into testing or more exotic build scenarios.

Add link to commit that switches to VCPKG for dependency libs.

citkane · 2025-08-29T15:03:45Z

Note from the build log: -- Found Python: C:/Python313/python.exe (found version "3.13.6") found components: Interpreter, so I think that we are good with the default choco install python.

citkane added 2 commits August 5, 2025 13:45

Update WindowsPort.md

dfc98a3

As per WebKit#129

citkane changed the title ~~Update WindowsPort.md as per #129~~ Update WindowsPort.md as per #129 and other advisories Aug 12, 2025

citkane added 2 commits August 13, 2025 15:32

Update WindowsPort.md

23de9e0

Update WindowsPort.md

6beb1ae

donny-dont reviewed Aug 13, 2025

View reviewed changes

citkane added 3 commits August 13, 2025 18:36

Update WindowsPort.md

617bab2

Update WindowsPort.md

17f7833

Update WindowsPort.md

c413ea1

donny-dont reviewed Aug 13, 2025

View reviewed changes

Update WindowsPort.md

f17aab2

donny-dont reviewed Aug 13, 2025

View reviewed changes

docs/Ports/WindowsPort.md Outdated Show resolved Hide resolved

citkane added 2 commits August 13, 2025 23:39

Update WindowsPort.md

8a3f853

Update WindowsPort.md

4e61b14

mxschmitt reviewed Aug 20, 2025

View reviewed changes

docs/Ports/WindowsPort.md Outdated Show resolved Hide resolved

mxschmitt reviewed Aug 20, 2025

View reviewed changes

docs/Ports/WindowsPort.md Show resolved Hide resolved

citkane added 2 commits August 28, 2025 19:54

Merge branch 'WebKit:main' into patch-1

8dc22c0

Update WindowsPort.md

e7e3f67

Add patch fix for CMake complications with woff2

citkane commented Aug 28, 2025

View reviewed changes

docs/Ports/WindowsPort.md Outdated Show resolved Hide resolved

Update WindowsPort.md

be90997

Mixed CMake with patch build fails. Force PATH to bundled CMake 3.x instead.

citkane commented Aug 29, 2025

View reviewed changes

Update WindowsPort.md

f03dd45

Housekeeping, formatting, semantics and update to consider VCPKG build in recent WebKit versions.

citkane commented Aug 29, 2025

View reviewed changes

Update WindowsPort.md

49c61a1

Add link to commit that switches to VCPKG for dependency libs.

		rem Set PATH to use the VS toolchain bundled CMake 3.x. This ensures that downstream vcpkg builds will succeed.
		path %DevEnvDir%CommonExtensions\\Microsoft\\CMake\\CMake\\bin;%path%

Update WindowsPort.md as per #129 and other advisories #130

Are you sure you want to change the base?

Update WindowsPort.md as per #129 and other advisories #130

Uh oh!

Conversation

citkane commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

donny-dont left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

citkane Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

donny-dont left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

citkane Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

citkane commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

citkane commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

citkane commented Aug 5, 2025 •

edited

Loading

citkane Aug 13, 2025 •

edited

Loading

citkane Aug 29, 2025 •

edited

Loading

citkane commented Aug 29, 2025 •

edited

Loading

citkane commented Aug 29, 2025 •

edited

Loading