* Update list of supported platforms
[obnox/wireshark/wip.git] / README.cmake
1           Explain the cmake build system for wireshark
2
3    $Id$
4
5                            Notice 
6
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.
11
12 Table of contents
13 =================
14
15 How to get started with cmake?
16 Why cmake?
17 Why not cmake?
18 What needs to be done?
19 Links regarding cmake
20
21 How to get started with cmake?
22 ==============================
23
24 You can find documentation on cmake at: http://www.cmake.org/
25
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.
28
29 How to do out of tree build (Unix/Linux):
30 1) Install cmake.
31 2) Assuming, you are in the top directory of the wireshark source
32    cd ..
33 3) mkdir build
34 4) cd build
35 5) cmake ../<Name_of_WS_source_dir>
36 6) make
37
38 Note 1:
39 in step 5), you may override the defaults for features:
40  cmake -DENABLE_CAP=OFF ../<Name_of_WS_source_dir>
41  will disable the capabilities check.
42
43 Note 2:
44  On OS X, you may want to run cmake like this:
45  cmake -DENABLE_CAP=OFF -G "Unix Makefiles"
46
47 Why cmake?
48 ==========
49 - Can create project files for some MS and Apple IDEs.
50 - Fast
51 - Easier to understand/learn
52 - Doesn't create any files in the source tree in case
53   of out of tree builds
54 - One build infrastructure even including Windows
55 ...
56
57 Why not cmake?
58 ==============
59 - Lots of work to do
60 - Everyone who wants to build from source needs cmake
61 - Current state of documentation isn't really better than
62   autofoo documentation, in some respect it's even worse
63   (you need to buy a book to get an explanation as to how
64   cmake really works).
65 ...
66
67 What works?
68 ===========
69
70 All the executables now build from clean source on:
71 * 32bit openSUSE 11.1
72 * 32bit Ubuntu 9.04
73
74 What needs to be done?
75 ======================
76
77 - Add asn1 autogen target (assigned: krj)
78 - Redo glib2 and gtk2 find modules.
79 - Add back platform specific objects.
80 - Fix places in the cmake files marked as todo.
81 - Add back (working) install target.
82   Currently, directories are created with user umask
83 - Add back -Werror
84 - Bug with empty list and PRINT_DISABLED_FEATURES?
85 - Add back compiler flags test
86 - Build source package (using CPack).
87 - Build rpm package (using CPack).
88 - Build dpkg package (using CPack).
89 - Add back checkAPI target.
90 - Test and add support for other platforms (BSDs, OSX,
91   Solaris, Win32, Win64, ...)
92 ...
93
94 Links regarding cmake
95 =====================
96 The home page of the cmake project
97         http://www.cmake.org/
98
99 The home page of the cmake project documentation
100         http://www.cmake.org/Wiki/CMake
101
102 About cmake in general and why KDE4 uses it
103         http://lwn.net/Articles/188693/
104
105 Introductory/tutorial presentation
106         http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
107
108 Introductory arcticle in Linux Journal
109         http://www.linuxjournal.com/node/6700/print
110
111 Useful variables
112         http://www.cmake.org/Wiki/CMake_Useful_Variables
113
114 cmake FAQ
115         http://www.cmake.org/Wiki/CMake_FAQ
116
117 Additional cmake modules
118         http://code.google.com/p/cmake-modules/