vcpkg_cmake_configure
CMake ベースのプロジェクトを構成します。
使用方法
vcpkg_cmake_configure(
SOURCE_PATH <source-path>
[DISABLE_PARALLEL_CONFIGURE]
[NO_CHARSET_FLAG]
[WINDOWS_USE_MSBUILD]
[GENERATOR <generator>]
[LOGFILE_BASE <logname-base>]
[OPTIONS
<configure-setting>...]
[OPTIONS_RELEASE
<configure-setting>...]
[OPTIONS_DEBUG
<configure-setting>...]
[MAYBE_UNUSED_VARIABLES
<option-name>...]
)
この関数を使用するには、ヘルパー ポートの vcpkg-cmake
に依存する必要があります。
"dependencies": [
{
"name": "vcpkg-cmake",
"host": true
}
]
パラメーター
SOURCE_PATH
CMakeLists.txt
を含むディレクトリを指定します。
通常、この値は、 vcpkg_from_github()
などのソース取得コマンドを呼び出した結果として取得されます。
DISABLE_PARALLEL_CONFIGURE
CMake 構成ステップの並列実行を無効にします。
既定では、vcpkg はソース ディレクトリへの書き戻しを無効にし (文書化されていない CMake フラグ CMAKE_DISABLE_SOURCE_CHANGES
を使用して)、Release と Debug を並列で構成します。 このフラグは、ソース ディレクトリの書き込みを許可し、構成手順を順番に実行するように vcpkg に指示します。
NO_CHARSET_FLAG
組み込みの Windows ツールチェーンを使用する場合、/utf-8
の受け渡しを無効にします。
これは、MSVC をターゲットにするときに独自のソース コードの文字セットを設定するライブラリに必要です。 詳細については、/utf-8
のMSVC ドキュメントを参照してください。
WINDOWS_USE_MSBUILD
Windows プラットフォームを対象とする場合は、別のジェネレーターの代わりに MSBuild を使用します。
既定では、vcpkg は、すべてのプラットフォームの CMake ジェネレーターとして Ninja を使用することを好みます。 ただし、MSBuild の動作が Ninja とは異なるエッジ ケースがあります。 このフラグは、プロジェクトで MSBuild を正しくビルドする必要がある場合にのみ渡す必要があります。 このフラグは MinGW ターゲットには影響しません。
ジェネレータ
使用する CMake ジェネレーターを指定します。
既定では、vcpkg では、すべてのプラットフォームで CMake ジェネレーターとして Ninja を使用し、Ninja を使用できない場合は Windows 以外のプラットフォームの場合は "Unix Makefiles" を使用します。 このパラメーターは、プロジェクト固有のビルドシステムが特定のジェネレーターに依存するエッジ ケースに使用できます。
LOGFILE_BASE
構成ログの代替ルート名。
既定値は config-${TARGET_TRIPLET}
です。 パス区切り記号は含めないようにしてください。 パターンに一致するログが生成されます ${CURRENT_BUILDTREES_DIR}/${LOGFILE_BASE}-<suffix>.log
[オプション (オプション)]
構成中に CMake に渡す追加のオプション。
「 Implicit オプション」も参照してください。
OPTIONS_RELEASE
リリース構成中に CMake に渡す追加のオプション。
これらは、 OPTIONS
に加えてあります。
OPTIONS_DEBUG
デバッグ構成中に CMake に渡す追加のオプション。
これらは、 OPTIONS
に加えてあります。
MAYBE_UNUSED_VARIABLES
構成手順中に読み取られない可能性がある CMake オプションの一覧。
vcpkg は、CMake 構成手順中に読み取られないオプションについて、このリストの外部にあるオプションについて警告します。 この一覧には、特定の構成中にのみ読み取るオプション ( VCPKG_LIBRARY_LINKAGE
が "static"
されたときや、特定の機能が有効になっている場合など) が含まれている必要があります。
暗黙的なオプション
このコマンドは、CMake にいくつかのオプションを自動的に提供します。
CMAKE_BUILD_TYPE
は、必要に応じて"Release"
または"Debug"
に設定されます。BUILD_SHARED_LIBS
は、VCPKG_LIBRARY_LINKAGE
の値に従って設定されます。CMAKE_INSTALL_PREFIX=${CURRENT_PACKAGES_DIR}</debug>
構成に応じてCMAKE_TOOLCHAIN_FILE
VCPKG_CHAINLOAD_TOOLCHAIN_FILE
は、vcpkg ツールチェーン ファイルおよび triplet ツールチェーンを含むように設定されます。CMAKE_SYSTEM_NAME=${VCPKG_CMAKE_SYSTEM_NAME}
.VCPKG_CMAKE_SYSTEM_NAME
が未設定の場合、既定値は"Windows"
になります。CMAKE_SYSTEM_VERSION=${VCPKG_CMAKE_SYSTEM_VERSION}
VCPKG_CMAKE_SYSTEM_VERSION
が設定されている場合は &。CMAKE_EXPORT_NO_PACKAGE_REGISTRY=ON
CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY=ON
CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY=ON
CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS_SKIP=TRUE
CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION=ON
CMAKE_INSTALL_LIBDIR:STRING=lib
CMAKE_INSTALL_BINDIR:STRING=bin
FETCHCONTENT_FULLY_DISCONNECTED=ON
(バージョン 2022-10-30 以降)
このコマンドは、 VCPKG_CMAKE_CONFIGURE_OPTIONS
のすべてのオプションと、 VCPKG_CMAKE_CONFIGURE_OPTIONS_RELEASE
または VCPKG_CMAKE_CONFIGURE_OPTIONS_DEBUG
から構成固有のオプションも渡します。
最後に、依存すべきではない追加の内部オプションが渡されます ( VCPKG_
プレフィックスを使用)。
例
vcpkg_from_github(OUT_SOURCE_PATH source_path ...)
vcpkg_cmake_configure(
SOURCE_PATH "${source_path}"
OPTIONS
-DBUILD_EXAMPLES=OFF
-DBUILD_TESTS=OFF
)
vcpkg_cmake_install()
例については、microsoft/vcpkg を検索してください
解説
このコマンドは、 vcpkg_configure_cmake()
を置き換えます。
ソース
vcpkg