1 Explain the cmake build system for wireshark
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 Basically this is an experiment and if we find out that it works
8 and we like cmake more than autofoo we might switch one day.
13 How to get started with cmake?
16 What needs to be done?
19 How to get started with cmake?
20 ==============================
22 You can find documentation on cmake at: http://www.cmake.org/
24 cmake is designed to support out of tree builds. So much so, that
25 in tree builds do not work properly in all cases.
27 How to do out of tree build (Unix/Linux):
29 2) Assuming, you are in the top directory of the wireshark source
33 5) cmake ../<Name_of_WS_source_dir>
34 6) make (or cmake --build .)
35 7) (as root) umask 0022 && make install
38 in step 5), you may override the defaults for features:
39 cmake -DENABLE_CAP=OFF ../<Name_of_WS_source_dir>
40 will disable the capabilities check.
43 On OS X, you may want to run cmake like this:
44 cmake -DENABLE_CAP=OFF -G "Unix Makefiles"
47 After running cmake, you can always run "make help" to see
48 a list of all possible make targets.
51 Cmake honors user umask for creating directories as of now:
52 http://public.kitware.com/Bug/view.php?id=9620
53 To get predictable results please set umask explicitly.
55 How to do out of tree build (Win32/64):
56 [This is advanced alpha and should build all executables except the GTK3
57 Wireshark for 32-bit.]
58 1) Follow http://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html
60 1a) Set WIRESHARK_BASE_DIR=c:\wireshark (the parent directory of the
62 1b) set WIRESHARK_TARGET_PLATFORM=win32 (or win64)
63 1c) set QT5_BASE_DIR=c:\Qt\Qt5.1.1\5.1.1\msvc2010 (or whatever)
64 1d) In case you want to use Visual Studio, make sure that the paths
65 to python and cygwin are available to GUI applications.
67 2a) Build the zlib library, e.g.
68 cd %WIRESHARK_BASE_DIR%\wireshark-%WIRESHARK_TARGET_PLATFORM%-libs\zlib125
69 cmake -G "NMake Makefiles" . # msbuild will not do because of configuration path
71 3) mkdir c:\wireshark\build
72 4) cd c:\wireshark\build
73 5) cmake -G "NMake Makefiles" path\to\sources
74 (i.e. in case your sources are located at c:\wireshark\trunk, use "..\trunk")
75 5a) cmake path\to\sources (this will build for the latest Visual Studio version found)
76 6) nmake /X- VERBOSE=1 (or cmake --build . -- VERBOSE=1 )
77 6a) Wireshark.sln (this will run up Visual Studio with the cmake built solution
78 (or use msbuild: cmake --build . -- /p:Configuration=RelWithDebInfo)
79 7) In case you want to test the executable(s) inside the build tree:
80 Run setpath.bat whenever it gets updated (there is a message in each cmake
81 run whether it is necessary or not).
85 - Can create project files for some MS and Apple IDEs.
87 - Easier to understand/learn
88 - Doesn't create any files in the source tree in case
90 - One build infrastructure even including Windows
96 - Everyone who wants to build from source needs cmake
97 - Current state of documentation isn't really better than
98 autofoo documentation, in some respect it's even worse
99 (you need to buy a book to get an explanation as to how
106 All the executables now build from clean source on:
107 * 32bit openSUSE 11.3: (gnu)make and gcc
111 * 64bit Debian Wheezy
113 What needs to be done?
114 ======================
116 - Add back platform specific objects.
117 - Fix places in the cmake files marked as todo.
118 - Guides are not installed.
119 - Build source package (using CPack).
120 This is obsolete if we decide to release VCS snapshots instead
121 - Build rpm package (using CPack).
122 - Build dpkg package (using CPack).
123 This is obsolete, we should call CMake from debian/rules instead, using dh
125 - Add back checkAPI target.
126 - Test and add support for other platforms (BSDs, OSX,
127 Solaris, Win32, Win64, ...)
128 - Add support for cmake configurations.
129 - Get plugins loading when running *shark from the build directory.
130 - Automatically figure out if *shark is running from the build directory
131 (making WIRESHARK_RUN_FROM_BUILD_DIRECTORY unnecessary like it is with
133 - Get cross-compilation working (or ensure it does). It works with autofoo.
136 Links regarding cmake
137 =====================
138 The home page of the cmake project
139 http://www.cmake.org/
141 The home page of the cmake project documentation
142 http://www.cmake.org/Wiki/CMake
144 About cmake in general and why KDE4 uses it
145 http://lwn.net/Articles/188693/
147 Introductory/tutorial presentation
148 http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
150 Introductory article in Linux Journal
151 http://www.linuxjournal.com/node/6700/print
154 http://www.cmake.org/Wiki/CMake_Useful_Variables
157 http://www.cmake.org/Wiki/CMake_FAQ
159 Additional cmake modules
160 http://code.google.com/p/cmake-modules/