From 475daf767f96dae856c568870990b55f4481df75 Mon Sep 17 00:00:00 2001 From: Gerald Combs Date: Fri, 16 Mar 2018 10:33:58 -0700 Subject: [PATCH] More CMake documentation updates. Change-Id: Ia568e0f46e7a38007bb9b8ea3d6c92233921cc46 Reviewed-on: https://code.wireshark.org/review/26504 Reviewed-by: Gerald Combs --- INSTALL | 8 ++++---- docbook/wsdg_src/WSDG_chapter_tools.asciidoc | 18 ++++++++++++------ 2 files changed, 16 insertions(+), 10 deletions(-) diff --git a/INSTALL b/INSTALL index ae0b519ade..412168f12c 100644 --- a/INSTALL +++ b/INSTALL @@ -67,10 +67,10 @@ README.windows for those instructions. spaces. 7. Run 'cmake ' in your build - directory. Running 'cmake -L' displays a complete list of options. - The "Tool Reference" section of Developer's Guide contains general - instructions for using CMake. Some of the Wireshark-specific options - are as follows: + directory. Running 'cmake -LH ' + displays a complete list of options. The "Tool Reference" section of + Developer's Guide contains general instructions for using CMake. Some + of the Wireshark-specific options are as follows: -G Ninja CMake supports many different build systems, including UNIX diff --git a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc index f8e1891d4b..953e58dc29 100644 --- a/docbook/wsdg_src/WSDG_chapter_tools.asciidoc +++ b/docbook/wsdg_src/WSDG_chapter_tools.asciidoc @@ -194,30 +194,36 @@ Using CMake on Windows is described further in <>. Along with specifying a generator with the `-G` flag you can set variables using the `-D` flag. Useful variables and generators include the following: +-DBUILD_wireshark=OFF:: Don't build the Wireshark GUI application. +Each command line utility has its own BUILD_xxx flag as well. For +example, you can use -DBUILD_mmdbresolve=OFF to disable mmdbresolve. + -DENABLE_CAP=OFF:: Disable the POSIX capabilities check -DCMAKE_BUILD_TYPE=Debug:: Enable debugging symbols --DENABLE_GTK3=ON:: Enable GTK+ 3 +-DCARES_INCLUDE_DIR=/your/custom/cares/include, -DCARES_LIBRARY=/your/custom/cares/lib/libcares.so:: +Let you set the path to a locally-compiled version of c-ares. Most +optional libraries have xxx_INCLUDE_DIR and xxx_LIB flags that let you +control their discovery. -+++-DCMAKE_C_FLAGS='-Qunused-arguments'+++:: Make ccache and clang work together -DPYTHON_EXECUTABLE=c:/Python27/python:: Force the Python path. Useful on Windows since Cygwin’s /usrbin/python is a symlink. -DENABLE_APPLICATION_BUNDLE=OFF:: Disable building an application bundle (Wireshark.app) on macOS -You can list all build variables (with help) by running *`cmake -LH [options] -../`*. This lists the cache of build variables +You can list all build variables (with help) by running `cmake -LH [options] +../`. This lists the cache of build variables after the cmake run. To only view the current cache, add option `-N`. -After running cmake, you can always run *`make help`* to see a list of all possible make targets. +After running cmake, you can always run `make help` to see a list of all possible make targets. Note that CMake honors user umask for creating directories as of now. You should set the umask explicitly before running the `install` target. CMake links: -The home page of the CMake project: http://www.cmake.org/ +The home page of the CMake project: https://cmake.org/ Official documentation: https://cmake.org/documentation/