Last modified 2 years ago Last modified on 06/29/14 08:27:04

Build Instructions for the QtWebKit build on Windows


Please install these tools in a path without spaces (i.e. not in "C:\Program Files")

Make sure the GnuWin32 packages are in your PATH as well as Perl and Python. You also need to have %QTDIR% set and have %QTDIR%\bin in your PATH.
If you have Cygwin's bin directory in your path, make sure that it comes after ActiveState Perl and GnuWin32. You might have to remove it completely from your PATH if you have problems with slashes and backslashes while building using MinGW. mingw32-make and GnuWin32's make will use sh.exe to run commands if they find it in the PATH.

For SQLite, download the 'amalgamation' sources and make sure you set SQLITE3SRCDIR environment variable to the directory containing the source files. (You could also set %SQLITE3SRCDIR% to the sources in your Qt's source directory e.g src/3rdparty/sqlite in Qt 4.8; tested.) As of June 2014, most sources and tutorials miss this point, which causes build failure of the unofficial QtWebKit-2.3 with MSVC and Qt 4.7~4.8.

Building QtWebKit

  • Open a Qt Command Prompt from the Start Menu.
    • Alternatively you can use a MSVC or MinGW command line environment that matches the version of Qt you downloaded and make sure qmake is accessible in PATH.
      Note that building inside Cygwin or MSYS is currently not supported. Please use a Windows command prompt.
  • Chdir into the WebKit source tree
  • Run perl Tools\Scripts\build-webkit --qt --release
  • Wait :)
  • Try to run WebKitBuild\Release\bin\QtTestBrowser.exe

Notes about building QtWebKit with the Qt/Windows OpenSource Edition

  • If you want to compile using multiple cores:
    • On MinGW you can try set MAKE_COMMAND=mingw32-make -j%NUMBER_OF_PROCESSORS%.
      If this do not work you might have to Ctrl-C build-webkit's execution, go in the WebKitBuild\Release\ directory and run:
      mingw32-make -C JavaScriptCore -f Makefile.Release -j%NUMBER_OF_PROCESSORS% && mingw32-make -C WebCore -f Makefile.Release -j%NUMBER_OF_PROCESSORS% && mingw32-make
    • On MSVC use the CL environment variable along with the /MP switch:
      set CL= /MP
  • If you haven't set up your PATH already to include the GnuWin32 packages then you may want to execute the following command: set PATH=C:\GnuWin32\bin;C:\Perl\bin;%PATH% Provided that the GnuWin32 packages are installed in C:\GnuWin32\bin and Perl in C:\Perl\bin.
  • If you get complaints about 'win_flex' not found, in your GnuWin32 folder simply duplicate 'flex.exe' and rename it 'win_flex.exe' - without the quotes :D (Or download the "original" win_flex from the link at Dependencies section).
  • If you get build errors in JavaScriptCore\bindings\NP_jsobject.cpp or similar then please make sure that the Microsoft Platform SDK is NOT in your %INCLUDE% path because it conflicts with your MingW headers.
  • If you get build errors in WebCore\Modules\webdatabase\WorkerContextWebDatabase.cpp or similar then you haven't made SQLite available. Read the paragraphs at the end of the Dependencies section to know how.
  • If you get build errors after makefile generation (Makefile:178: *** Multiple target patterns. Stop.) then you're probably still using the Cygwin version of make. Try removing Cygwin from your %PATH% for the time being (it's not currently supported, as mentioned above).

A 'Works For Me' Step-by-Step Guide to building QtWebKit on Windows using mingw-w64/w32

  1. The patch in bug report may not yet have been applied to Qt git, apply manually if necessary
  2. Until Qt 4.7 is released, use the git version of Qt 4.7:
  3. Get a mingw-w64 build with mingw32-make:
  4. Set up your environment:
    • Qt sources are in C:\Qt so that configure.exe is present in that directory
    • perl is installed: (installer should add perl.exe to PATH)
    • open cmd.exe
    • run following commands:
      set PATH=C:\mingw64\bin;C:\Qt\bin;%PATH%
      set QTDIR=C:\Qt
      cd C:\Qt
      configure -qt-style-windowsxp -qt-style-windowsvista -phonon
  5. Everything should have built. Have fun!

Remarks: mingw-w64/w32 also provides a toolchain targetting 32-bit windows. Sezero provides builds: The procedure to compile Qt is exactly the same, only that he mingw64 folder name should be mingw32.

A 'Works For Me' Step-by-Step Guide to Building QtWebKit on Windows using MinGW

  1. The the mentioned GnuWin32 tools
  2. Download QT SDK (and QT Creator) and Download ActivePerl
  3. Open for example a Qt Command Prompt from the Start Menu. Click Start->Program Files->Qt->QT Command Prompt. In fact, you really do need to use Qt Command Prompt for this rather than the normal windows command prompt.
  4. Make sure the GnuWin32 packages are in your PATH as well as Perl (set PATH=C:\program files\gnuwin32\bin;C:\Perl\site\bin;%PATH%.
  5. You also need to have %QTDIR% set and have %QTDIR%\bin in your PATH.
  6. Trim your PATH down as much as possible. Remove Git and Mingw from your PATH if you have them installed, their presence can cause odd build failures. For example, the PATH that works for me is:
     set Path=c:\GnuWin32\bin;c:\Qt\2009.01\qt\bin;c:\Qt\2009.01\bin;C:\Perl\bin;C:\Windows\system32;c:\Qt\2009.01\mingw\bin;C:\Perl\site\bin;C:\Windows
    • Note that c:\Qt\2009.01\qt above will vary depending on the QT SDK that you downloaded. You should modify it appropriately.
  7. Download WebKit from svn (make sure you've left the location of your svn client in your %PATH% above):
    $ svn checkout %HOME%\WebKit
    $ cd %HOME%/WebKit
  8. Change into the WebKit source tree: cd c:\location\of\webkit
  9. For some reason, the build command was unable to create the WebKitBuild\Release folders by itself on my PC. I had to do mkdir WebKitBuild and mkdir WebKitBuild\Release before building.
  10. You may need to do a mkdir c:\tmp. The WebKit build relies on the existence of c:\tmp when building in Windows.
  11. Build the patched webkit (release mode): $perl Tools\Scripts\build-webkit --qt --release
  12. The webkit build takes forever, you can shorten it using the build-webkit's --no-svg or --minimal flags:
        $perl Tools\Scripts\build-webkit --qt --release --no-svg
        $perl Tools\Scripts\build-webkit --qt --release --minimal

Speedup Git on Windows

Git tends to be rather slow for repositories with a huge amount of files on Windows. One way to deal with that is to use a sparse-checkout, to "ignore" certain files. The LayoutTests directory is certainly a good candidate, if you currently do not need these files. A sparse-checkout uses a config file (.git/info/sparse-checkout) to determine if a file should be checked out or not. Files mentioned in the config file will be part of the checkout. Files not mentioned in the config file will be ignored. There is also a syntax to invert this logic, but it is currently not working well with directories.

  1. Create a .git/info/sparse-checkout file that will ignore the LayoutTests directory:
  2. Enable sparse-checkout:
    git config core.sparsecheckout true
  3. Remove the LayoutTests directory if it is already there:
    rmdir /s LayoutTests
  4. Update the git tree cache:
    git read-tree -m -u HEAD
  5. Check which files have been excluded:
    git ls-files -v | grep ^S