Avoid adding -pie on older cmake versions
[metze/wireshark/wip.git] / README.cmake
1           Explain the cmake build system for wireshark
2
3                            Notice
4
5    To find out the current state of the cmake implementation for
6    Wireshark, please take a look at "What needs to be done?" below.
7
8 Table of contents
9 =================
10
11 How to get started with cmake (Unix/Linux and Win32/64)?
12 Why cmake?
13 Why not cmake?
14 What needs to be done?
15 Links regarding cmake
16
17 How to get started with cmake (Unix/Linux and Win32/64)?
18 ========================================================
19
20 You can find documentation on cmake at: http://www.cmake.org/
21
22 cmake is designed to support out of tree builds. So much so, that
23 in tree builds do not work properly in all cases.
24
25 How to do out of tree build (Unix/Linux):
26 1) Install cmake.
27 2) Assuming, you are in the top directory of the wireshark source
28    cd ..
29 3) mkdir build
30 4) cd build
31 5) cmake [options] ../<Name_of_WS_source_dir>
32 6) make (or cmake --build .)
33 7) (as root) umask 0022 && make install
34
35 Note 1:
36   In step 5) you may need to override the defaults for features. Common
37   options include:
38
39   # Disable the POSIX capbabilities check
40   -DENABLE_CAP=OFF
41
42   # Enable debugging symbols
43   -DCMAKE_BUILD_TYPE=Debug
44
45   # Disable GTK+ 3
46   -DENABLE_GTK3=OFF
47
48   # Build documentation
49   -DENABLE_HTML_GUIDES=ON
50   -DENABLE_PDF_GUIDES=ON
51
52   # Make ccache and clang work together
53   -DCMAKE_C_FLAGS='-Qunused-arguments'
54
55   # Force Python path on Windows. May be needed if Cygwin's
56   # /usr/bin/python is present and is a symlink
57   # http://public.kitware.com/Bug/view.php?id=13818
58   -DPYTHON_EXECUTABLE=c:/Python27/python
59
60   # Disable building an application bundle (Wireshark.app) on Mac OS X
61   -DENABLE_APPLICATION_BUNDLE=OFF
62
63   # Qt Creator expects .cbp files when used with CMake.
64   -G "CodeBlocks - Unix Makefiles"
65   -G "CodeBlocks - NMake Makefiles"
66
67 Note 2:
68   After running cmake, you can always run "make help" to see
69   a list of all possible make targets.
70
71 Note 3:
72   Cmake honors user umask for creating directories as of now:
73   http://public.kitware.com/Bug/view.php?id=9620
74   To get predictable results please set umask explicitly.
75
76 How to do an out of tree build using Visual C++ 2013:
77 [This is at rc status and should build all executables, support for VS2010 and VS2012
78  is included, but hasn't been tested.]
79 0) Install cmake (currently 3.1.3 or later is recommended).  You can use chocolatey,
80    choco inst cmake.
81 1) Follow https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html
82    Steps 1-9
83 1a) Set the library search path.
84     If you set WIRESHARK_BASE_DIR,
85     %WIRESHARK_BASE_DIR%\wireshark-%WIRESHARK_TARGET_PLATFORM%-libs will
86     be used as the top-level library directory.
87     If you set WIRESHARK_LIB_DIR, it will be used as the top-level library
88     directory.  This definition will require changing for different builds (x86 & x64).
89 1b) set WIRESHARK_TARGET_PLATFORM=win32 (or win64)
90 1c) set QT5_BASE_DIR=C:\Qt\5.4.1\5.4\msvc2013_opengl (must match the Qt component path
91     on your system)
92 1d) If you want to use Visual Studio to build rather than msbuild from the command line,
93     make sure that the path to Cygwin is available to GUI applications.
94 2) mkdir c:\wireshark\build or as appropriate for you.
95    You will need one build directory for each bitness (win32, win64) you wish to build.
96 3) cd into the directory from 2) above.
97 4) Run the following to generate the build files:
98    cmake -DENABLE_CHM_GUIDES=on xxx path\to\sources
99    where path\to\sources is the absolute or relative path to the wireshark source tree
100    and xxx is replaced with one of the following:
101        nothing - This will build a VS solution for win32 using the latest version of VS found (preferred).
102        -G "Visual Studio 12" ("12" builds for VS2013. Use "11" for VS2012 or "10" for VS2010.)
103        -G "NMake Makefiles" - to build an nmake makefile.
104        -G "Visual Studio 12 Win64" (Win32 is the default)
105 5) Run one of the following to build Wireshark:
106    msbuild /m /p:Configuration=RelWithDebInfo wireshark.sln (preferred).
107    Open Wireshark.sln in Windows Explorer to build in Visual Studio
108    nmake /X- VERBOSE=1 (or cmake --build . -- VERBOSE=1 ) (if you generated nmake files).
109    Subsequent changes to source files and CMakeLists.txt will be automagically detected
110    and new build files generated, i.e. step 4) doesn't need to be run again.
111    Changes to the build environment, e.g. QT_BASE_DIR aren't detected so you must delete the
112    build dir and start form step 2) again.
113 6) The executables can be run from the appropriate directory, e.g. run\RelWithDebInfo for VS solutions
114    or run\ for NMake files.
115 7) To build an installer, build the nsis_package project, e.g.
116    msbuild /m /p:Configuration=RelWithDebInfo nsis_package.vcxproj
117    nmake ???
118
119 Why cmake?
120 ==========
121 - Can create project files for many IDEs including Qt Creator, Visual Studio,
122   and XCode.
123 - Fast
124 - Easier to understand/learn
125 - Doesn't create any files in the source tree in case of out of tree builds
126 - One build infrastructure for all of our tier 1 platforms (including Windows)
127
128 Why not cmake?
129 ==============
130 - Lots of work to do
131 - Everyone who wants to build from source needs cmake
132 - Current state of documentation isn't really better than
133   Autotools documentation. In some respects it's even worse
134   (you need to buy a book to get an explanation as to how
135   cmake really works).
136 ...
137
138 What works?
139 ===========
140
141 All the executables now build from clean source on:
142 * 32 bit openSUSE 11.3: (gnu)make and gcc
143 * 64 bit FedoraXXX
144 * 32 bit Ubuntu 9.04
145 * 32 bit Ubuntu 10.04
146 * 64 bit Ubuntu 14.04
147 * 64 bit Debian Wheezy
148 * 32 bit OS X
149 * 64 bit OS X
150 * 32 bit Windows using Visual C++ 2013
151 * 64 bit Windows using Visual C++ 2013
152 * 64 bit Solaris 10
153
154 The Buildbot runs CMake steps on Ubuntu, Win32, Win64, OS X, and Solaris.
155 Windows packages are built using CMake steps.
156
157 What needs to be done?
158 ======================
159
160 - Add back platform specific objects.
161 - Fix places in the cmake files marked as todo.
162 - Guides are not installed.
163 - Build source package (using CPack).
164   This is obsolete if we decide to release VCS snapshots instead
165 - Build packages using CPack: tarball, Windows installer + PortableApps, OS X
166   installer dmg, RPM, SVR4. This includes setting OS target version stuff
167   appropriately for OS X. We currently use NSIS for the Windows installer but
168   should probably use WiX instead.
169 - Add support for cmake configurations.
170 - Automatically figure out if *shark is running from the build directory
171   (making WIRESHARK_RUN_FROM_BUILD_DIRECTORY unnecessary like it is with
172   autofoo).
173   Sadly:
174
175       $ file run/qtshark
176       run/qtshark: Mach-O 64-bit x86_64 executable
177
178   so what you're running from the build directory is the executable
179   itself.  autofoo includes libtool in our case, so what you're running
180   from the build directory is a script that then runs the executable,
181   and the executable is in a .libs directory; the code that checks for
182   "running from the build directory?" checks for that.  The actual
183   executable isn't supposed to be run directly - it's expected to be run
184   by the wrapper script and might not even work if run directly, as it
185   won't find the relevant shared libraries.
186
187   We could perhaps check for the executable being in a "run" directory
188   instead, if the build drops it there.  However, it's possible, at
189   least on OS X, to copy the executable to another directory and have
190   it run, so the guarantee that it's in a "run" directory is not as
191   strong.
192 - Get plugins loading when running *shark from the build directory.
193   That might involve handling ".libs" and "run" differently.  The chance
194   that a random directory the executable was ultimately placed in would
195   be named "run" might also be a bit bigger than the chance that it's
196   named ".libs".
197 - Get cross-compilation working (or ensure it does). It works with autofoo--and
198   people use it.
199 - Handle -DFORTIFY_SOURCE=2 appropriately.  (Do a Web search for
200   "cmake fortify" for some information.)
201 - Define the GTK_DISABLE_ and GDK_DISABLE_ values as appropriate if we
202   care about supporting the GTK+ version.
203 - Install the freedesktop integration files (wireshark.desktop,
204   wireshark-mime-package.xml, etc.).
205 ...
206
207 Links regarding cmake
208 =====================
209 The home page of the cmake project
210         http://www.cmake.org/
211
212 The home page of the cmake project documentation
213         http://www.cmake.org/Wiki/CMake
214
215 About cmake in general and why KDE4 uses it
216         http://lwn.net/Articles/188693/
217
218 Introductory/tutorial presentation
219         http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
220
221 Introductory article in Linux Journal
222         http://www.linuxjournal.com/node/6700/print
223
224 Useful variables
225         http://www.cmake.org/Wiki/CMake_Useful_Variables
226
227 cmake FAQ
228         http://www.cmake.org/Wiki/CMake_FAQ
229
230 Additional cmake modules
231         http://code.google.com/p/cmake-modules/