README.cmake

   1 Placeholder for cmake development stuff :-)
   2
   3                            Notice
   4
   5    The CMake build system for Wireshark is not yet ready for
   6    building the whole system. You'll still need autofoo to buld it.
   7    The only thing that can be build is dumpcap, and even that one
   8    requires that you successfully ran autofoo prior to running cmake
   9    (e.g. config.h is not yet build, lex and yacc are not run).
  10    Basically this is an experiment and if we find out that it works
  11    and we like cmake more than autofoo we might switch one day.
  12
  13 Table of contents
  14 =================
  15
  16 How to get started with cmake?
  17 Why cmake?
  18 Why not cmake?
  19 What needs to be done?
  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) Build the project with the old build system once (to generate
  32    config.h and run bison and flex to generate some c-files).
  33 3) Assuming, you are in the top directory of the wireshark source
  34    cd ..
  35 4) mkdir build
  36 5) cd build
  37 6) cmake ../<Name_of_WS_source_dir>
  38 7) make
  39
  40 Why cmake?
  41 ==========
  42 - Can create project files for some MS and Apple IDEs.
  43 - Fast
  44 - Easier to understand/learn
  45 - One build infrastructure even including Windows?
  46 ...
  47
  48 Why not cmake?
  49 ==============
  50 - Lots of work to do
  51 - Everyone who wants to build from source needs cmake
  52 - Current state of documentation isn't really better than
  53   autofoo documentation, in some respect it's even worse
  54   (you need to buy a book to get an explanation as to how
  55   cmake really works).
  56 ...
  57
  58 What needs to be done?
  59 ======================
  60
  61 only dumpcap and libwiretap have been done, and even those rely on
  62 autofoo having been run before:
  63
  64 - Add proper GTK1/GLIB2/GLIB1 detection (currently links against gtk2
  65   to pull in glib2).
  66 - Create config.h
  67 - Autocreated source files in wiretap need to be build from .l, .y files.
  68
  69 All other tools and libs still need to be built.
  70