README.cmake

   1           Explain the cmake build system for wireshark
   2
   3                            Notice
   4
   5    To find out the current state of the cmake implementation for
   6    Wireshark, please take a look at "What needs to be done?" below.
   7    Basically this is an experiment and if we find out that it works
   8    and we like cmake more than autofoo we might switch one day.
   9
  10 Table of contents
  11 =================
  12
  13 How to get started with cmake (Unix/Linux and Win32/64)?
  14 Why cmake?
  15 Why not cmake?
  16 What needs to be done?
  17 Links regarding cmake
  18
  19 How to get started with cmake (Unix/Linux and Win32/64)?
  20 ========================================================
  21
  22 You can find documentation on cmake at: http://www.cmake.org/
  23
  24 cmake is designed to support out of tree builds. So much so, that
  25 in tree builds do not work properly in all cases.
  26
  27 How to do out of tree build (Unix/Linux):
  28 1) Install cmake.
  29 2) Assuming, you are in the top directory of the wireshark source
  30    cd ..
  31 3) mkdir build
  32 4) cd build
  33 5) cmake [options] ../<Name_of_WS_source_dir>
  34 6) make (or cmake --build .)
  35 7) (as root) umask 0022 && make install
  36
  37 Note 1:
  38   In step 5) you may need to override the defaults for features. Common
  39   options include:
  40
  41   # Disable the POSIX capbabilities check
  42   -DENABLE_CAP=OFF
  43
  44   # Enable debugging symbols
  45   -DCMAKE_BUILD_TYPE=Debug
  46
  47   # Disable GTK+ 3
  48   -DENABLE_GTK3=OFF
  49
  50   # Build documentation
  51   -DENABLE_GUIDES=ON
  52
  53   # Make ccache and clang work together
  54   -DCMAKE_C_FLAGS='-Qunused-arguments'
  55
  56   # Force Python path on Windows. May be needed if Cygwin's
  57   # /usr/bin/python is present and is a symlink
  58   # http://public.kitware.com/Bug/view.php?id=13818
  59   -DPYTHON_EXECUTABLE=c:/Python27/python
  60
  61   # Disable building an application bundle (Wireshark.app) on Mac OS X
  62   -DENABLE_APPLICATION_BUNDLE=OFF
  63
  64 Note 2:
  65   After running cmake, you can always run "make help" to see
  66   a list of all possible make targets.
  67
  68 Note 3:
  69   Cmake honors user umask for creating directories as of now:
  70   http://public.kitware.com/Bug/view.php?id=9620
  71   To get predictable results please set umask explicitly.
  72
  73 How to do an out of tree build using Visual C++ 2013:
  74 [This is advanced alpha and should build all executables except the GTK3
  75  Wireshark for 32-bit.]
  76 1) Follow https://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html
  77    Steps 1-9
  78 1a) Set the library search path.
  79     If you set WIRESHARK_LIB_DIR, it will be used as the top-level library
  80     directory.
  81     If you set WIRESHARK_BASE_DIR,
  82     %WIRESHARK_BASE_DIR%\wireshark-%WIRESHARK_TARGET_PLATFORM%-libs will
  83     be used as the top-level library directory.
  84 1b) set WIRESHARK_TARGET_PLATFORM=win32 (or win64)
  85 1c) set QT5_BASE_DIR=C:\Qt\5.3\msvc2013_opengl (must match the Qt component path
  86     on your system)
  87 1d) If you want to use Visual Studio make sure that the paths to Python and
  88     Cygwin are available to GUI applications. The Python path MUST come first.
  89 2) Install cmake
  90 2a) Build the zlib library, e.g.
  91     cd %WIRESHARK_BASE_DIR%\wireshark-%WIRESHARK_TARGET_PLATFORM%-libs\zlib125
  92     cmake -G "NMake Makefiles" . # msbuild will not do because of configuration path
  93     cmake --build .
  94 3) mkdir c:\wireshark\build
  95 4) cd c:\wireshark\build
  96 5) Run one of the following to create the build environment:
  97    cmake -G "NMake Makefiles" path\to\sources  (i.e. in case your sources are located at c:\wireshark\trunk, use "..\trunk")
  98    cmake path\to\sources (this will build for the latest Visual Studio version found)
  99    cmake -G "Visual Studio 12" ("12" builds for VS2103. Use "11" for VS2012 or "10" for VS2010.)
 100    cmake -G "Visual Studio 12 Win64" (Win32 is the default)
 101 6) Run one of the following to build Wireshark:
 102    nmake /X- VERBOSE=1 (or cmake --build . -- VERBOSE=1 )
 103    Open Wireshark.sln in Windows Explorer to build in Visual Studio
 104    msbuild wireshark.sln /m /p:Configuration=RelWithDebInfo
 105 7) In case you want to test the executable(s) inside the build tree:
 106    Run setpath.bat whenever it gets updated (there is a message in each cmake
 107    run whether it is necessary or not).
 108
 109 Why cmake?
 110 ==========
 111 - Can create project files for many IDEs including Qt Creator, Visual Studio,
 112   and XCode.
 113 - Fast
 114 - Easier to understand/learn
 115 - Doesn't create any files in the source tree in case of out of tree builds
 116 - One build infrastructure for all of our tier 1 platforms (including Windows)
 117
 118 Why not cmake?
 119 ==============
 120 - Lots of work to do
 121 - Everyone who wants to build from source needs cmake
 122 - Current state of documentation isn't really better than
 123   Autotools documentation. In some respects it's even worse
 124   (you need to buy a book to get an explanation as to how
 125   cmake really works).
 126 ...
 127
 128 What works?
 129 ===========
 130
 131 All the executables now build from clean source on:
 132 * 32 bit openSUSE 11.3: (gnu)make and gcc
 133 * 64 bit FedoraXXX
 134 * 32 bit Ubuntu 9.04
 135 * 32 bit Ubuntu 10.04
 136 * 64 bit Ubuntu 14.04
 137 * 64 bit Debian Wheezy
 138 * 32 bit OS X
 139 * 64 bit OS X
 140 * 32 bit Windows using Visual C++ 2013
 141 * 64 bit Windows using Visual C++ 2013
 142 * 64 bit Solaris 10
 143
 144 The Buildbot runs CMake steps on Ubuntu, Win32, Win64, OS X, and Solaris.
 145
 146 What needs to be done?
 147 ======================
 148
 149 - Add back platform specific objects.
 150 - Fix places in the cmake files marked as todo.
 151 - Guides are not installed.
 152 - Build source package (using CPack).
 153   This is obsolete if we decide to release VCS snapshots instead
 154 - Build packages using CPack: tarball, Windows installer + PortableApps, OS X
 155   installer dmg, RPM, SVR4. This includes setting OS target version stuff
 156   appropriately for OS X. We currently use NSIS for the Windows installer but
 157   should probably use WiX instead.
 158 - Add back checkAPI target.
 159 - Add support for cmake configurations.
 160 - Automatically figure out if *shark is running from the build directory
 161   (making WIRESHARK_RUN_FROM_BUILD_DIRECTORY unnecessary like it is with
 162   autofoo).
 163   Sadly:
 164
 165       $ file run/qtshark
 166       run/qtshark: Mach-O 64-bit x86_64 executable
 167
 168   so what you're running from the build directory is the executable
 169   itself.  autofoo includes libtool in our case, so what you're running
 170   from the build directory is a script that then runs the executable,
 171   and the executable is in a .libs directory; the code that checks for
 172   "running from the build directory?" checks for that.
 173
 174   We could perhaps check for the pathname containing "run/", although
 175   that wouldn't help if we ran it while *in* the "run" directory;
 176   getting an absolute path for the executable would be necessary for
 177   that.
 178 - Get plugins loading when running *shark from the build directory.
 179   That might involve handling ".libs" and "run" differently.
 180 - Get cross-compilation working (or ensure it does). It works with autofoo.
 181 - Handle -DFORTIFY_SOURCE=2 appropriately.  (Do a Web search for
 182   "cmake fortify" for some information.)
 183 - Add support for Visual Studio code anlaysis similar to ENABLE_CODE_ANALYSIS in
 184   config.nmake.
 185 - Define the GTK_DISABLE_ and GDK_DISABLE_ values as appropriate if we
 186   care about supporting the GTK+ version.
 187 - Install the freedesktop integration files (wireshark.desktop,
 188   wireshark-mime-package.xml, etc.).
 189 ...
 190
 191 Links regarding cmake
 192 =====================
 193 The home page of the cmake project
 194         http://www.cmake.org/
 195
 196 The home page of the cmake project documentation
 197         http://www.cmake.org/Wiki/CMake
 198
 199 About cmake in general and why KDE4 uses it
 200         http://lwn.net/Articles/188693/
 201
 202 Introductory/tutorial presentation
 203         http://ait.web.psi.ch/services/linux/hpc/hpc_user_cookbook/tools/cmake/docs/Cmake_VM_2007.pdf
 204
 205 Introductory article in Linux Journal
 206         http://www.linuxjournal.com/node/6700/print
 207
 208 Useful variables
 209         http://www.cmake.org/Wiki/CMake_Useful_Variables
 210
 211 cmake FAQ
 212         http://www.cmake.org/Wiki/CMake_FAQ
 213
 214 Additional cmake modules
 215         http://code.google.com/p/cmake-modules/