README.cmake

   1           Explain the cmake build system for wireshark
   2
   3    $Id$
   4
   5                            Notice
   6
   7    The CMake build system for Wireshark is not yet ready for
   8    building the whole system. You'll still need autofoo to buld it.
   9    The only thing that can be build is dumpcap, and even that one
  10    requires that you successfully ran autofoo prior to running cmake
  11    (e.g. config.h is not yet build, lex and yacc are not run).
  12    Basically this is an experiment and if we find out that it works
  13    and we like cmake more than autofoo we might switch one day.
  14
  15 Table of contents
  16 =================
  17
  18 How to get started with cmake?
  19 Why cmake?
  20 Why not cmake?
  21 What needs to be done?
  22 Links regarding cmake
  23
  24 How to get started with cmake?
  25 ==============================
  26
  27 You can find documentation on cmake at: http://www.cmake.org/
  28
  29 cmake is designed to support out of tree builds. So much so, that
  30 in tree builds do not work properly in all cases.
  31
  32 How to do out of tree build (Unix/Linux):
  33 1) Install cmake.
  34 2) Build the project with the old build system once (to generate
  35    config.h and run bison and flex to generate some c-files).
  36 3) Assuming, you are in the top directory of the wireshark source
  37    cd ..
  38 4) mkdir build
  39 5) cd build
  40 6) cmake ../<Name_of_WS_source_dir>
  41 7) make
  42
  43 Why cmake?
  44 ==========
  45 - Can create project files for some MS and Apple IDEs.
  46 - Fast
  47 - Easier to understand/learn
  48 - One build infrastructure even including Windows?
  49 ...
  50
  51 Why not cmake?
  52 ==============
  53 - Lots of work to do
  54 - Everyone who wants to build from source needs cmake
  55 - Current state of documentation isn't really better than
  56   autofoo documentation, in some respect it's even worse
  57   (you need to buy a book to get an explanation as to how
  58   cmake really works).
  59 ...
  60
  61 What needs to be done?
  62 ======================
  63
  64 only dumpcap and libwiretap have been done, and even those rely on
  65 autofoo having been run before:
  66
  67 - Add proper GTK1/GLIB2/GLIB1 detection (currently links against gtk2
  68   to pull in glib2).
  69 - Create config.h
  70 - Autocreated source files in wiretap need to be build from .l, .y files.
  71
  72 All other tools and libs still need to be built.
  73
  74 Links regarding cmake
  75 =====================
  76 The home page of the cmake project
  77         http://www.cmake.org/
  78
  79 The home page of the cmake project documentation
  80         http://www.cmake.org/Wiki/CMake
  81
  82 About cmake in general and why KDE4 uses it
  83         http://lwn.net/Articles/188693/
  84
  85 Introductory arcticle in Linux Journal
  86         http://www.linuxjournal.com/node/6700/print
  87
  88 Useful variables
  89         http://www.cmake.org/Wiki/CMake_Useful_Variables
  90
  91 cmake FAQ
  92         http://www.cmake.org/Wiki/CMake_FAQ
  93
  94 Additional cmake modules
  95         http://code.google.com/p/cmake-modules/