Git+docs: Ignore and document CMakeListsCustom.txt.

This commit is contained in:
Gerald Combs 2022-05-23 09:47:04 -07:00 committed by A Wireshark GitLab Utility
parent be929e162d
commit b4376b4533
2 changed files with 7 additions and 0 deletions

1
.gitignore vendored
View File

@ -60,6 +60,7 @@ wireshark-tap-register.c
/*build*/ /*build*/
CMakeCache.txt CMakeCache.txt
CMakeFiles CMakeFiles
CMakeListsCustom.txt
cmake_install.cmake cmake_install.cmake
CPackConfig.cmake CPackConfig.cmake
CPackSourceConfig.cmake CPackSourceConfig.cmake

View File

@ -107,6 +107,8 @@ using the `-D` flag. Useful variables and generators include the following:
Each command line utility has its own BUILD_xxx flag as well. For Each command line utility has its own BUILD_xxx flag as well. For
example, you can use -DBUILD_mmdbresolve=OFF to disable mmdbresolve. example, you can use -DBUILD_mmdbresolve=OFF to disable mmdbresolve.
-DENABLE_CCACHE=ON:: Build using the ccache compiler cache.
-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
@ -127,6 +129,10 @@ 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`.
You prepopulate variables using CMake's https://cmake.org/cmake/help/latest/manual/cmake.1.html#options[`-C` command line option] or by adding a file named `CMakeListsCustom.txt` to the top-level source directory.
In either case you must set each variable using CMake's “set” command.
For example `set(ENABLE_CCACHE ON)` will enable ccache.
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