ceph/src/jaegertracing/opentelemetry-cpp/tools/vcpkg/docs/maintainers/vcpkg_configure_cmake.md

   1 # vcpkg_configure_cmake
   2
   3 **This function has been deprecated in favor of [`vcpkg_cmake_configure`](ports/vcpkg-cmake/vcpkg_cmake_configure.md) from the vcpkg-cmake port.**
   4
   5 The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_configure_cmake.md).
   6
   7 Configure CMake for Debug and Release builds of a project.
   8
   9 ## Usage
  10 ```cmake
  11 vcpkg_configure_cmake(
  12     SOURCE_PATH <${SOURCE_PATH}>
  13     [PREFER_NINJA]
  14     [DISABLE_PARALLEL_CONFIGURE]
  15     [NO_CHARSET_FLAG]
  16     [GENERATOR <"NMake Makefiles">]
  17     [OPTIONS <-DUSE_THIS_IN_ALL_BUILDS=1>...]
  18     [OPTIONS_RELEASE <-DOPTIMIZE=1>...]
  19     [OPTIONS_DEBUG <-DDEBUGGABLE=1>...]
  20 )
  21 ```
  22
  23 ## Parameters
  24 ### SOURCE_PATH
  25 Specifies the directory containing the `CMakeLists.txt`.
  26 By convention, this is usually set in the portfile as the variable `SOURCE_PATH`.
  27
  28 ### PREFER_NINJA
  29 Indicates that, when available, Vcpkg should use Ninja to perform the build.
  30 This should be specified unless the port is known to not work under Ninja.
  31
  32 ### DISABLE_PARALLEL_CONFIGURE
  33 Disables running the CMake configure step in parallel.
  34 This is needed for libraries which write back into their source directory during configure.
  35
  36 This also disables CMAKE_DISABLE_SOURCE_CHANGES.
  37
  38 ### NO_CHARSET_FLAG
  39 Disables passing `utf-8` as the default character set to `CMAKE_C_FLAGS` and `CMAKE_CXX_FLAGS`.
  40
  41 This is needed for libraries that set their own source code's character set.
  42
  43 ### GENERATOR
  44 Specifies the precise generator to use.
  45
  46 This is useful if some project-specific buildsystem has been wrapped in a cmake script that won't perform an actual build.
  47 If used for this purpose, it should be set to `"NMake Makefiles"`.
  48
  49 ### OPTIONS
  50 Additional options passed to CMake during the configuration.
  51
  52 ### OPTIONS_RELEASE
  53 Additional options passed to CMake during the Release configuration. These are in addition to `OPTIONS`.
  54
  55 ### OPTIONS_DEBUG
  56 Additional options passed to CMake during the Debug configuration. These are in addition to `OPTIONS`.
  57
  58 ### LOGNAME
  59 Name of the log to write the output of the configure call to.
  60
  61 ## Notes
  62 This command supplies many common arguments to CMake. To see the full list, examine the source.
  63
  64 ## Examples
  65
  66 * [zlib](https://github.com/Microsoft/vcpkg/blob/master/ports/zlib/portfile.cmake)
  67 * [cpprestsdk](https://github.com/Microsoft/vcpkg/blob/master/ports/cpprestsdk/portfile.cmake)
  68 * [poco](https://github.com/Microsoft/vcpkg/blob/master/ports/poco/portfile.cmake)
  69 * [opencv](https://github.com/Microsoft/vcpkg/blob/master/ports/opencv/portfile.cmake)
  70
  71 ## Source
  72 [scripts/cmake/vcpkg\_configure\_cmake.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_configure_cmake.cmake)