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 implementation 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 (or cmake --build .)
  37 7) (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 How to do out of tree build (Win32/64):
  58 [This is advanced alpha and should build all executables except the GTK3
  59  Wireshark for 32-bit.]
  60 1) Follow http://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html
  61    Steps 1-9
  62 1a) Set WIRESHARK_BASE_DIR=c:\wireshark (the parent directory of the
  63    library directory).
  64 1b) set WIRESHARK_TARGET_PLATFORM=win32 (or win64)
  65 1c) set QT5_BASE_DIR=c:\Qt\Qt5.1.1\5.1.1\msvc2010 (or whatever)
  66 2) Install cmake
  67 2a) Build the zblib library, e.g.
  68     cd %WIRESHARK_BASE_DIR%\wireshark-%WIRESHARK_TARGET_PLATFORM%-libs\zlib125
  69     cmake -G "NMake Makefiles" . # msbuild will not do because of configuration path
  70     cmake --build .
  71 3) mkdir c:\wireshark\build
  72 4) cd c:\wireshark\build
  73 5) cmake -G "NMake Makefiles" path\to\sources
  74   (i.e. in case your sources are located at c:\wireshark\trunk, use "..\trunk")
  75 5a) cmake path\to\sources (this will build for the latest Visual Studio version found)
  76 6) nmake /X- VERBOSE=1 (or cmake --build . -- VERBOSE=1 )
  77 6a) Wireshark.sln (this will run up Visual Studio with the cmake built solution
  78    (or use msbuild: cmake --build . -- /p:Configuration=RelWithDebInfo)
  79 7) In case you want to test the executable(s) inside the build tree:
  80    Run setpath.bat whenever it gets updated (there is a message in each cmake
  81    run whether it is necessary or not).
  82
  83 Why cmake?
  84 ==========
  85 - Can create project files for some MS and Apple IDEs.
  86 - Fast
  87 - Easier to understand/learn
  88 - Doesn't create any files in the source tree in case
  89   of out of tree builds
  90 - One build infrastructure even including Windows
  91 ...
  92
  93 Why not cmake?
  94 ==============
  95 - Lots of work to do
  96 - Everyone who wants to build from source needs cmake
  97 - Current state of documentation isn't really better than
  98   autofoo documentation, in some respect it's even worse
  99   (you need to buy a book to get an explanation as to how
 100   cmake really works).
 101 ...
 102
 103 What works?
 104 ===========
 105
 106 All the executables now build from clean source on:
 107 * 32bit openSUSE 11.3: (gnu)make and gcc
 108 * 64bit FedoraXXX
 109 * 32bit Ubuntu 9.04
 110 * 32bit Ubuntu 10.04
 111 * 64bit Debian Wheezy
 112
 113 What needs to be done?
 114 ======================
 115
 116 - Add back platform specific objects.
 117 - Fix places in the cmake files marked as todo.
 118 - Guides are not installed.
 119 - Build source package (using CPack).
 120   This is obsolete if we decide to release VCS snapshots instead
 121 - Build rpm package (using CPack).
 122 - Build dpkg package (using CPack).
 123   This is obsolete, we should call CMake from debian/rules instead, using dh
 124   (rbalint)
 125 - Add back checkAPI target.
 126 - Test and add support for other platforms (BSDs, OSX,
 127   Solaris, Win32, Win64, ...)
 128 - Add support for cmake configurations.
 129 - Get plugins loading when running *shark from the build directory.
 130 - Automatically figure out if *shark is running from the build directory
 131   (making WIRESHARK_RUN_FROM_BUILD_DIRECTORY unnecessary like it is with
 132   autofoo).
 133 - Get cross-compilation working (or ensure it does). It works with autofoo.
 134 ...
 135
 136 Links regarding cmake
 137 =====================
 138 The home page of the cmake project
 139         http://www.cmake.org/
 140
 141 The home page of the cmake project documentation
 142         http://www.cmake.org/Wiki/CMake
 143
 144 About cmake in general and why KDE4 uses it
 145         http://lwn.net/Articles/188693/
 146
 147 Introductory/tutorial presentation
 148         http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
 149
 150 Introductory article in Linux Journal
 151         http://www.linuxjournal.com/node/6700/print
 152
 153 Useful variables
 154         http://www.cmake.org/Wiki/CMake_Useful_Variables
 155
 156 cmake FAQ
 157         http://www.cmake.org/Wiki/CMake_FAQ
 158
 159 Additional cmake modules
 160         http://code.google.com/p/cmake-modules/