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 Note 3:
  48   After running cmake, you can always run "make help" to see
  49   a list of all possible make targets.
  50
  51 Why cmake?
  52 ==========
  53 - Can create project files for some MS and Apple IDEs.
  54 - Fast
  55 - Easier to understand/learn
  56 - Doesn't create any files in the source tree in case
  57   of out of tree builds
  58 - One build infrastructure even including Windows
  59 ...
  60
  61 Why not cmake?
  62 ==============
  63 - Lots of work to do
  64 - Everyone who wants to build from source needs cmake
  65 - Current state of documentation isn't really better than
  66   autofoo documentation, in some respect it's even worse
  67   (you need to buy a book to get an explanation as to how
  68   cmake really works).
  69 ...
  70
  71 What works?
  72 ===========
  73
  74 All the executables now build from clean source on:
  75 * 32bit openSUSE 11.3: (gnu)make and gcc
  76 * 64bit FedoraXXX
  77 * 32bit Ubuntu 9.04
  78 * 32bit Ubuntu 10.04
  79
  80 What needs to be done?
  81 ======================
  82
  83 - Add asn1 autogen target (assigned: krj)
  84 - Add back platform specific objects.
  85 - Fix places in the cmake files marked as todo.
  86 - Add back (working) install target.
  87   Currently, directories are created with user umask.
  88   Also the guides are not installed.
  89 - Build source package (using CPack).
  90 - Build rpm package (using CPack).
  91 - Build dpkg package (using CPack).
  92 - Add back checkAPI target.
  93 - Test and add support for other platforms (BSDs, OSX,
  94   Solaris, Win32, Win64, ...)
  95 ...
  96
  97 Links regarding cmake
  98 =====================
  99 The home page of the cmake project
 100         http://www.cmake.org/
 101
 102 The home page of the cmake project documentation
 103         http://www.cmake.org/Wiki/CMake
 104
 105 About cmake in general and why KDE4 uses it
 106         http://lwn.net/Articles/188693/
 107
 108 Introductory/tutorial presentation
 109         http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
 110
 111 Introductory arcticle in Linux Journal
 112         http://www.linuxjournal.com/node/6700/print
 113
 114 Useful variables
 115         http://www.cmake.org/Wiki/CMake_Useful_Variables
 116
 117 cmake FAQ
 118         http://www.cmake.org/Wiki/CMake_FAQ
 119
 120 Additional cmake modules
 121         http://code.google.com/p/cmake-modules/