Updated WebKit import
[mirror/qt/qt5.git] / README
1 HOW TO BUILD QT5
2 ================
3
4
5  Synopsis
6  ========
7
8  For a stable build of Qt5:
9
10    ./init-repository
11    ./configure -prefix $PWD/qtbase -opensource
12    make -j4
13
14  More details follow.
15
16
17  Get The Submodules
18  ==================
19
20  Cloning Qt5 does not automatically clone all submodules.
21  To get the submodules, it is recommended to use the `init-repository' script.
22
23    ./init-repository
24
25  If you are a Nokia developer, you should add the -nokia-developer argument:
26
27    ./init-repository -nokia-developer
28
29  See `./init-repository -help' for full documentation on the many supported
30  options.
31
32
33  Update The Submodules (optional)
34  ================================
35
36  After a plain `git clone' and `init-repository', you will have each submodule
37  checked out to a particular SHA1.  This combination of SHA1s is guaranteed to
38  have passed some basic acceptance testing.
39
40  If (and only if!) you need newer versions of some submodules, you can manually
41  fetch and/or pull and/or reset any modules you like, or use the qt5_tool to
42  pull all modules:
43
44    ./qtrepotools/bin/qt5_tool -p
45
46  NOTE! As soon as you change the SHA1 of any submodule, you are using a
47  combination of modules which is potentially untested and broken!  If you want
48  something which is more likely to compile, stick to the module SHA1s provided
49  in this repository.
50
51
52  Install The Git Grafts (optional)
53  =================================
54
55  If you want to be able to connect the Qt5 and Qt4 development history, you
56  may set up git grafts with the following command:
57
58    git submodule foreach '../qtrepotools/bin/git-qt-grafts <path_to_history>'
59
60
61  Build!
62  ======
63
64  A typical `configure; make' build process is used.
65
66  Example for a release build:
67  (adjust the `-jN' parameter as appropriate for your system)
68
69    ./configure -prefix $PWD/qtbase -opensource
70    make -j4
71
72  Example for a developer build:
73  (enables more autotests, builds debug version of libraries, ...)
74
75    ./configure -developer-build -opensource
76    make -j4
77
78  See output of `./configure -help' for documentation on various options to
79  configure.
80
81  The above examples will build whatever Qt5 modules have been enabled by
82  default in the build system.
83
84  It is possible to build selected modules with their dependencies by doing
85  a `make module-<foo>'.  For example, to build only qtscript and qtwebkit,
86  and the modules they depend on:
87
88    ./configure -prefix $PWD/qtbase -opensource
89    make -j4 module-qtscript module-qtwebkit
90
91  This can save a lot of time if you are only interested in a subset of Qt5.
92
93
94  Hints
95  =====
96
97  Shadow builds are possible, but not as well tested/supported as in-source
98  builds.
99
100  You can disable parts of the build to speed up compilation or to work around
101  problems by configuring with:
102
103     -nomake tests -nomake examples
104
105  You can pass -confirm-license to configure to automatically acknowledge the
106  LGPL 2.1 license.
107
108  The qt5_tool in qtrepotools has some more features which may be of interest.
109  Try `qt5_tool --help'.