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

   1 # vcpkg_configure_make
   2
   3 The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_configure_make.md).
   4
   5 Configure configure for Debug and Release builds of a project.
   6
   7 ## Usage
   8 ```cmake
   9 vcpkg_configure_make(
  10     SOURCE_PATH <${SOURCE_PATH}>
  11     [AUTOCONFIG]
  12     [USE_WRAPPERS]
  13     [DETERMINE_BUILD_TRIPLET]
  14     [BUILD_TRIPLET "--host=x64 --build=i686-unknown-pc"]
  15     [NO_ADDITIONAL_PATHS]
  16     [CONFIG_DEPENDENT_ENVIRONMENT <SOME_VAR>...]
  17     [CONFIGURE_ENVIRONMENT_VARIABLES <SOME_ENVVAR>...]
  18     [ADD_BIN_TO_PATH]
  19     [NO_DEBUG]
  20     [SKIP_CONFIGURE]
  21     [PROJECT_SUBPATH <${PROJ_SUBPATH}>]
  22     [PRERUN_SHELL <${SHELL_PATH}>]
  23     [OPTIONS <-DUSE_THIS_IN_ALL_BUILDS=1>...]
  24     [OPTIONS_RELEASE <-DOPTIMIZE=1>...]
  25     [OPTIONS_DEBUG <-DDEBUGGABLE=1>...]
  26 )
  27 ```
  28
  29 ## Parameters
  30 ### SOURCE_PATH
  31 Specifies the directory containing the `configure`/`configure.ac`.
  32 By convention, this is usually set in the portfile as the variable `SOURCE_PATH`.
  33
  34 ### PROJECT_SUBPATH
  35 Specifies the directory containing the ``configure`/`configure.ac`.
  36 By convention, this is usually set in the portfile as the variable `SOURCE_PATH`.
  37
  38 ### SKIP_CONFIGURE
  39 Skip configure process
  40
  41 ### USE_WRAPPERS
  42 Use autotools ar-lib and compile wrappers (only applies to windows cl and lib)
  43
  44 ### BUILD_TRIPLET
  45 Used to pass custom --build/--target/--host to configure. Can be globally overwritten by VCPKG_MAKE_BUILD_TRIPLET
  46
  47 ### DETERMINE_BUILD_TRIPLET
  48 For ports having a configure script following the autotools rules for selecting the triplet
  49
  50 ### NO_ADDITIONAL_PATHS
  51 Don't pass any additional paths except for --prefix to the configure call
  52
  53 ### AUTOCONFIG
  54 Need to use autoconfig to generate configure file.
  55
  56 ### PRERUN_SHELL
  57 Script that needs to be called before configuration (do not use for batch files which simply call autoconf or configure)
  58
  59 ### ADD_BIN_TO_PATH
  60 Adds the appropriate Release and Debug `bin\` directories to the path during configure such that executables can run against the in-tree DLLs.
  61
  62 ## DISABLE_VERBOSE_FLAGS
  63 do not pass '--disable-silent-rules --verbose' to configure
  64
  65 ### OPTIONS
  66 Additional options passed to configure during the configuration.
  67
  68 ### OPTIONS_RELEASE
  69 Additional options passed to configure during the Release configuration. These are in addition to `OPTIONS`.
  70
  71 ### OPTIONS_DEBUG
  72 Additional options passed to configure during the Debug configuration. These are in addition to `OPTIONS`.
  73
  74 ### CONFIG_DEPENDENT_ENVIRONMENT
  75 List of additional configuration dependent environment variables to set.
  76 Pass SOMEVAR to set the environment and have SOMEVAR_(DEBUG|RELEASE) set in the portfile to the appropriate values
  77 General environment variables can be set from within the portfile itself.
  78
  79 ### CONFIGURE_ENVIRONMENT_VARIABLES
  80 List of additional environment variables to pass via the configure call.
  81
  82 ## Notes
  83 This command supplies many common arguments to configure. To see the full list, examine the source.
  84
  85 ## Examples
  86
  87 * [x264](https://github.com/Microsoft/vcpkg/blob/master/ports/x264/portfile.cmake)
  88 * [tcl](https://github.com/Microsoft/vcpkg/blob/master/ports/tcl/portfile.cmake)
  89 * [freexl](https://github.com/Microsoft/vcpkg/blob/master/ports/freexl/portfile.cmake)
  90 * [libosip2](https://github.com/Microsoft/vcpkg/blob/master/ports/libosip2/portfile.cmake)
  91
  92 ## Source
  93 [scripts/cmake/vcpkg\_configure\_make.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_configure_make.cmake)