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 6) (as root) umask 0022 && make install
  38
  39 Note 1:
  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.
  43
  44 Note 2:
  45  On OS X, you may want to run cmake like this:
  46  cmake -DENABLE_CAP=OFF -G "Unix Makefiles"
  47
  48 Note 3:
  49   After running cmake, you can always run "make help" to see
  50   a list of all possible make targets.
  51
  52 Note 4:
  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.
  56
  57 Why cmake?
  58 ==========
  59 - Can create project files for some MS and Apple IDEs.
  60 - Fast
  61 - Easier to understand/learn
  62 - Doesn't create any files in the source tree in case
  63   of out of tree builds
  64 - One build infrastructure even including Windows
  65 ...
  66
  67 Why not cmake?
  68 ==============
  69 - Lots of work to do
  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
  74   cmake really works).
  75 ...
  76
  77 What works?
  78 ===========
  79
  80 All the executables now build from clean source on:
  81 * 32bit openSUSE 11.3: (gnu)make and gcc
  82 * 64bit FedoraXXX
  83 * 32bit Ubuntu 9.04
  84 * 32bit Ubuntu 10.04
  85 * 64bit Debian Wheezy
  86
  87 What needs to be done?
  88 ======================
  89
  90 - Add back platform specific objects.
  91 - Fix places in the cmake files marked as todo.
  92 - Guides are not installed.
  93 - Release notes are not built.
  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
  99   (rbalint)
 100 - Add back checkAPI target.
 101 - Test and add support for other platforms (BSDs, OSX,
 102   Solaris, Win32, Win64, ...)
 103 ...
 104
 105 Links regarding cmake
 106 =====================
 107 The home page of the cmake project
 108         http://www.cmake.org/
 109
 110 The home page of the cmake project documentation
 111         http://www.cmake.org/Wiki/CMake
 112
 113 About cmake in general and why KDE4 uses it
 114         http://lwn.net/Articles/188693/
 115
 116 Introductory/tutorial presentation
 117         http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
 118
 119 Introductory article in Linux Journal
 120         http://www.linuxjournal.com/node/6700/print
 121
 122 Useful variables
 123         http://www.cmake.org/Wiki/CMake_Useful_Variables
 124
 125 cmake FAQ
 126         http://www.cmake.org/Wiki/CMake_FAQ
 127
 128 Additional cmake modules
 129         http://code.google.com/p/cmake-modules/