1 Explain the cmake build system for wireshark
7 To find out the current state of the cmake implementaion for
8 Wireshark, please take a look at "What needs to be done?" below.
9 Basically this is an experiment and if we find out that it works
10 and we like cmake more than autofoo we might switch one day.
15 How to get started with cmake?
18 What needs to be done?
21 How to get started with cmake?
22 ==============================
24 You can find documentation on cmake at: http://www.cmake.org/
26 cmake is designed to support out of tree builds. So much so, that
27 in tree builds do not work properly in all cases.
29 How to do out of tree build (Unix/Linux):
31 2) Assuming, you are in the top directory of the wireshark source
35 5) cmake ../<Name_of_WS_source_dir>
37 6) (as root) umask 0022 && make install
40 in step 5), you may override the defaults for features:
41 cmake -DENABLE_CAP=OFF ../<Name_of_WS_source_dir>
42 will disable the capabilities check.
45 On OS X, you may want to run cmake like this:
46 cmake -DENABLE_CAP=OFF -G "Unix Makefiles"
49 After running cmake, you can always run "make help" to see
50 a list of all possible make targets.
53 Cmake honors user umask for creating directories as of now:
54 http://public.kitware.com/Bug/view.php?id=9620
55 To get predictable results please set umask explicitly.
59 - Can create project files for some MS and Apple IDEs.
61 - Easier to understand/learn
62 - Doesn't create any files in the source tree in case
64 - One build infrastructure even including Windows
70 - Everyone who wants to build from source needs cmake
71 - Current state of documentation isn't really better than
72 autofoo documentation, in some respect it's even worse
73 (you need to buy a book to get an explanation as to how
80 All the executables now build from clean source on:
81 * 32bit openSUSE 11.3: (gnu)make and gcc
87 What needs to be done?
88 ======================
90 - Add asn1 autogen target (assigned: krj)
91 - Add back platform specific objects.
92 - Fix places in the cmake files marked as todo.
93 - Guides are not installed.
94 - Build source package (using CPack).
95 This is obsolete if we decide to release VCS snapshots instead
96 - Build rpm package (using CPack).
97 - Build dpkg package (using CPack).
98 This is obsolete, we should call CMake from debian/rules instead, using dh
100 - Add back checkAPI target.
101 - Test and add support for other platforms (BSDs, OSX,
102 Solaris, Win32, Win64, ...)
105 Links regarding cmake
106 =====================
107 The home page of the cmake project
108 http://www.cmake.org/
110 The home page of the cmake project documentation
111 http://www.cmake.org/Wiki/CMake
113 About cmake in general and why KDE4 uses it
114 http://lwn.net/Articles/188693/
116 Introductory/tutorial presentation
117 http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
119 Introductory article in Linux Journal
120 http://www.linuxjournal.com/node/6700/print
123 http://www.cmake.org/Wiki/CMake_Useful_Variables
126 http://www.cmake.org/Wiki/CMake_FAQ
128 Additional cmake modules
129 http://code.google.com/p/cmake-modules/