summaryrefslogtreecommitdiffstats
path: root/README
blob: 93689e6f561f60e9ab6ebae952a4aa5634336cbe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
HOW TO BUILD QT5
================


 Synopsis
 ========

 For a stable build of Qt5:

   ./init-repository
   ./configure -prefix $PWD/qtbase -opensource
   make -j4

 More details follow.


 Get The Submodules
 ==================

 Cloning Qt5 does not automatically clone all submodules.
 To get the submodules, it is recommended to use the `init-repository' script.

   ./init-repository

 If you are a Nokia developer, you should add the -nokia-developer argument:

   ./init-repository -nokia-developer

 See `./init-repository -help' for full documentation on the many supported
 options.


 Update The Submodules (optional)
 ================================

 After a plain `git clone' and `init-repository', you will have each submodule
 checked out to a particular SHA1.  This combination of SHA1s is guaranteed to
 have passed some basic acceptance testing.

 If (and only if!) you need newer versions of some submodules, you can manually
 fetch and/or pull and/or reset any modules you like, or use the qt5_tool to
 pull all modules:

   ./qtrepotools/bin/qt5_tool -p

 NOTE! As soon as you change the SHA1 of any submodule, you are using a
 combination of modules which is potentially untested and broken!  If you want
 something which is more likely to compile, stick to the module SHA1s provided
 in this repository.


 Install The Git Grafts (optional)
 =================================

 If you want to be able to connect the Qt5 and Qt4 development history, you
 may set up git grafts with the following command:

   git submodule foreach '../qtrepotools/bin/git-qt-grafts <path_to_history>'


 Build!
 ======

 A typical `configure; make' build process is used.

 Example for a release build:
 (adjust the `-jN' parameter as appropriate for your system)

   ./configure -prefix $PWD/qtbase -opensource
   make -j4

 Example for a developer build:
 (enables more autotests, builds debug version of libraries, ...)

   ./configure -developer-build -opensource
   make -j4

 See output of `./configure -help' for documentation on various options to
 configure.

 The above examples will build whatever Qt5 modules have been enabled by
 default in the build system.

 It is possible to build selected modules with their dependencies by doing
 a `make module-<foo>'.  For example, to build only qtscript and qtwebkit,
 and the modules they depend on:

   ./configure -prefix $PWD/qtbase -opensource
   make -j4 module-qtscript module-qtwebkit

 This can save a lot of time if you are only interested in a subset of Qt5.


 Hints
 =====

 Shadow builds are possible, but not as well tested/supported as in-source
 builds.

 You can disable parts of the build to speed up compilation or to work around
 problems by configuring with:

    -nomake tests -nomake examples

 You can pass -confirm-license to configure to automatically acknowledge the
 LGPL 2.1 license.

 The qt5_tool in qtrepotools has some more features which may be of interest.
 Try `qt5_tool --help'.