More CMake documentation updates.

Change-Id: Ia568e0f46e7a38007bb9b8ea3d6c92233921cc46
Reviewed-on: https://code.wireshark.org/review/26504
Reviewed-by: Gerald Combs <gerald@wireshark.org>
This commit is contained in:
Gerald Combs 2018-03-16 10:33:58 -07:00
parent 507d8211e9
commit 475daf767f
2 changed files with 16 additions and 10 deletions

View File

@ -67,10 +67,10 @@ README.windows for those instructions.
spaces. spaces.
7. Run 'cmake <options> <path/to/the/wireshark/sources>' in your build 7. Run 'cmake <options> <path/to/the/wireshark/sources>' in your build
directory. Running 'cmake -L' displays a complete list of options. directory. Running 'cmake -LH <path/to/the/wireshark/sources>'
The "Tool Reference" section of Developer's Guide contains general displays a complete list of options. The "Tool Reference" section of
instructions for using CMake. Some of the Wireshark-specific options Developer's Guide contains general instructions for using CMake. Some
are as follows: of the Wireshark-specific options are as follows:
-G Ninja -G Ninja
CMake supports many different build systems, including UNIX CMake supports many different build systems, including UNIX

View File

@ -194,30 +194,36 @@ Using CMake on Windows is described further in <<ChWin32Generate>>.
Along with specifying a generator with the `-G` flag you can set variables Along with specifying a generator with the `-G` flag you can set variables
using the `-D` flag. Useful variables and generators include the following: 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 -DENABLE_CAP=OFF:: Disable the POSIX capabilities check
-DCMAKE_BUILD_TYPE=Debug:: Enable debugging symbols -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 Cygwins /usrbin/python is a symlink. -DPYTHON_EXECUTABLE=c:/Python27/python:: Force the Python path. Useful on Windows since Cygwins /usrbin/python is a symlink.
-DENABLE_APPLICATION_BUNDLE=OFF:: Disable building an application bundle (Wireshark.app) on macOS -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] You can list all build variables (with help) by running `cmake -LH [options]
../<Name_of_WS_source_dir>`*. This lists the cache of build variables ../<Name_of_WS_source_dir>`. This lists the cache of build variables
after the cmake run. To only view the current cache, add option `-N`. 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 Note that CMake honors user umask for creating directories as of now. You should set
the umask explicitly before running the `install` target. the umask explicitly before running the `install` target.
CMake links: 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/ Official documentation: https://cmake.org/documentation/