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