[[PageOutline]] = Build Instructions for the QtWebKit build on Windows = == Dependencies == * First of all you need a version of Qt for Windows. If you are an Open Source developer then you can download the Open Source Edition of Qt for Windows from the Nokia Website: [http://qt.nokia.com/downloads] * Note that you need to enable ICU support in the Qt build (also see http://doc-snapshot.qt-project.org/5.0/requirements-win.html) * Make sure that Qt is configured with {{{-openssl}}} if you want HTTPS support in QtWebKit. You will need the non-light version of [http://www.slproweb.com/products/Win32OpenSSL.html Win32 OpenSSL] libraries. * Install [http://www.activestate.com/Products/ActivePerl/ ActiveState Perl] * Install [http://www.python.org/download/ Python 2.x] (and add the installation location to your PATH) * Install [http://sourceware.org/pthreads-win32/ Pthreads-win32] to your QtSDK directory (Q: Why do we need it? A: https://bugs.webkit.org/show_bug.cgi?id=67864) * for MinGW build: * copy libpthreadGC2.a and pthreadGC2.dll to c:\QtSDK\Desktop\Qt\4.7.4\mingw\lib\ * copy pthread headers to c:\QtSDK\Desktop\Qt\4.7.4\mingw\include\ * for MSVC2008 build: * copy pthreadVC2.lib and pthreadVC2.dll to c:\QtSDK\Desktop\Qt\4.7.4\msvc2008\lib\ * copy pthread headers to c:\QtSDK\Desktop\Qt\4.7.4\msvc2008\include\ * The following external GNU tools are needed from the [http://gnuwin32.sourceforge.net/packages.html GnuWin32 Project]: * [http://gnuwin32.sourceforge.net/downlinks/bison.php Bison] * [http://gnuwin32.sourceforge.net/downlinks/gperf.php GPerf] * [http://gnuwin32.sourceforge.net/downlinks/grep.php Grep] * [http://gnuwin32.sourceforge.net/downlinks/flex.php Flex] * [http://gnuwin32.sourceforge.net/downlinks/libiconv.php LibIconv] (needed for bison) * [http://gnuwin32.sourceforge.net/downlinks/make.php Make] (not necessary if you want to build using MSVC) 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.[[BR]] 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. == 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.[[BR]]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%}}}.[[BR]] 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 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 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). * If you want to generate MSVC project files (e.g. so that you can debug/work from within MSVC) you can do it with the following steps * Run {{{perl Tools\Scripts\build-webkit --qt}}} and cancel the script after the derived sources are all generated * Run {{{perl Tools\Scripts\build-webkit --qt --qmakearg="-tp vc"}}}. This will generate MSVC project files and then it will fail * Open WebKit.sln from MSVC and build from MSVC. Building should succeed and you should be able to debug and work from within MSVC. == A 'Works For Me' Step-by-Step Guide to building QtWebKit on Windows using mingw-w64/w32 == 0. The patch in bug report https://bugs.webkit.org/show_bug.cgi?id=38747 may not yet have been applied to Qt git, apply manually if necessary 1. Until Qt 4.7 is released, use the git version of Qt 4.7: http://qt.gitorious.org/qt/qt/trees/4.7 2. Get a mingw-w64 build with mingw32-make: * I'm assuming you're running Windows x64, as you will be testing the build :) * Two options: * drangon: http://mingw-w64-dgn.googlecode.com/files Download the mingw-w64-bin-x86_64- package Download the make-w64-bin-x86_64- package Extract them both to C:\mingw64 so that mingw32-make.exe and g++.exe are present in the C:\mingw64\bin folder * sezero: http://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/Personal%20Builds Download any of the mingw-w64-x86_64-mingw_ packages. The exp/new/old suffixes are not important here Extract the package to C:\mingw64 so that g++.exe is present in C:\mingw64\bin Rename included gmake.exe to mingw32-make.exe 3. Set up your environment: * Qt sources are in C:\Qt so that configure.exe is present in that directory * perl is installed: http://strawberryperl.com/ (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 mingw32-make }}} 4. Everything should have built. Have fun! Remarks: mingw-w64/w32 also provides a toolchain targetting 32-bit windows. Sezero provides builds: http://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/ 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. [http://www.qtsoftware.com/downloads/sdk-windows-cpp Download QT SDK (and QT Creator)] and [http://www.activestate.com/store/download.aspx?prdGUID=81fbce82-6bd5-49bc-a915-08d58c2648ca 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 http://svn.webkit.org/repository/webkit/trunk %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 ''sparse-checkout'' file with all the files/directories that you need. You can use the following command in git-bash to create such a file that will ignore the ''LayoutTests'' directory. {{{ cd WebKit ls -a | grep ".[a-zA-Z]" | grep -Ev "^.git|LayoutTests$" > .git/info/sparse-checkout }}} 2. Update the git tree cache {{{ git read-tree -m -u HEAD }}} 2. Check which files have been excluded {{{ git ls-files -v | grep ^S }}}