このドキュメントでは、vcpkg に投稿するときに従うポリシー、ガイドライン、ベスト プラクティスについて説明します。
これは、次と同じ役割を果たすことを目的としています。
キュレーションされたレジストリ設計の目標
ポートを同時にインストールしなければならない
キュレーションされたレジストリに含まれるポートは、レジストリ内の他のすべてのポートが存在する場合に正常にビルドされる必要があります。 ポートの組み合わせ全体は、vcpkg の自動 CI によって定期的にテストされます。
ポートでは、次の操作を行わないでください。
- 別のポートと競合するファイルをインストールします。
- 「競合するライブラリを
manual-linkディレクトリに配置する」で説明されている、狭い範囲で明示的にリンクされたライブラリを除き、別のパッケージが所有するシンボルと定義をインストールしないでください。 - 別のポートの有無をテストします。 依存関係の宣言を除く。
例外は次の場合に行われます。
- 公式なキャパシティにおいて、別のポートを置き換えるポート。 これには、次の場合が含まれます。
- 同じプロジェクトから、後継となるコンポーネントが公開されています。
- 別のプロジェクトでは、フォークを通じて、放棄されたコンポーネントのメンテナンスを引き継ぎます。
- 別のプロジェクトが後続コンポーネントを公開します。
- プラットフォームの重複がないポート。 たとえば、Windowsをサポートしていない Linux コンポーネントのWindowsのみの置換です。
- このポリシーの前に存在し、ユーザーと共同作成者の数が証明可能なほど多いポート。
vcpkg メンテナーは、ケースバイケースで既存扱いの例外を評価します。 たとえば、boringssl はカスタム レジストリが利用可能になる前に追加されたものであり、OpenSSL フォーク ファミリーの標準プロバイダーは openssl であるにもかかわらず、依然として有意義なユーザーが存在するため、キュレーション済みレジストリに残されています。 事前の承認があったとしても、それだけでは例外は保証されません。
このポリシーに準拠していないポートは、キュレーションされたレジストリに受け入れることはできません。
ヒント
ポートをキュレーションされたレジストリに含めることができない場合は、 カスタム レジストリを発行 するか、 オーバーレイ ポートを使用することを検討してください。
ポートは、少なくとも 1 つの公式トリプレットでテストする必要があります
キュレーションされたレジストリ内のすべてのポートは、少なくとも1つの公式トリプレットでCI環境においてテストされる必要があります。
例外は次の場合に行われます。
- 次のような一時的な状況:
- CI インフラストラクチャを更新しないと、ポートはビルドされません。
- アップストリームの依存関係が最近破壊的変更されたため、ポートはビルドされません。状況を解決するための作業が進行中です。
- このポリシーの前に存在し、ユーザーと共同作成者の数が証明可能なほど多いポート。
少なくとも 1 つの公式トリプレットでテストできない新しいポートは、キュレーションされたレジストリには受け入れられません。 このポリシーに準拠しなくなり、上記の例外の対象ではない既存のポートは、レジストリから除外されます。 たとえば、ポートがサポートするすべての公式トリプレットで CI テストが無効になっており、例外が適用されない場合、そのポートはリストから除外されます。
ヒント
ポートをキュレーションされたレジストリに含めることができない場合は、 カスタム レジストリを発行 するか、 オーバーレイ ポートを使用することを検討してください。
パッケージ化されたコンポーネントは安定しており、活発に保守されているべきです
キュレーションされたレジストリにパッケージ化されたコンポーネントは、アクティブなメンテナンス中である必要があります。 非アクティブなコンポーネントのポートは一覧から削除される可能性があります。
次の場合、コンポーネントは非アクティブと見なされます。
- このコンポーネントのメンテナーは、このコンポーネントの廃止を発表しました。
- そのソース リポジトリはアーカイブ化されているか、あるいは貢献の受付を終了しています。
- メンテナーは応答しないか、到達できません。
- 意味のある変更は長い間行われません。
例外は、成熟していて安定していると見なされ、頻繁に変更を受け取らない基本コンポーネントに対して行われます。
たとえば、 zlibと指定します。
パッケージ化されたコンポーネントは成熟している必要がある
キュレーションされたレジストリにパッケージ化されたコンポーネントは成熟している必要があり、vcpkg のユーザーが使用することを目的としています。 個人利用を目的としたコンポーネントは、カスタム レジストリに公開する必要があります。
次のいずれかのステートメントが当てはまる場合、コンポーネントはキュレーションされたレジストリに十分に成熟したと見なされます。
- このコンポーネントのリリースは、少なくとも 6 か月前にさかのぼります。
- このコンポーネントは、少なくとも 6 か月間のアクティブなパブリック開発が確認できる。
- このコンポーネントは、少なくとも6か月にわたるリリース実績または活発な公開開発があるプロジェクトの公式な一部です。 たとえば、新しい Boost ライブラリや Qt コンポーネントなどです。
- このコンポーネントは、他の点において、以前の要件と同等の成熟度を示します。
コンポーネントが未成熟であることを示す指標は次のとおりです。
- コンポーネントは検索エンジンに表示されません。
- コンポーネントの名前は頻繁に変更されます。
- 他のライブラリとの競合。
ヒント
ポートをキュレーションされたレジストリに含めることができない場合は、 カスタム レジストリを発行 するか、 オーバーレイ ポートを使用することを検討してください。
PR 構造体
ポートごとに個別のプル要求を行う
小さいプル要求 (PR) を確認する方が簡単です。 プル要求では、1 つのポートに変更を加える必要があります。 これにより、継続的インテグレーション (CI) の結果の待機時間も短縮されます。
場合によっては、PR を 1 つのポートに制限できない場合があります。 たとえば、ポートを変更する場合、ダウンストリーム コンシューマーを更新または修正する必要があります。
関係のない外観の変更を避ける
変更を加えていないポートに対して、フォーマットの変更、変数の名前変更、誤字の修正など、内容とは無関係な外観上の変更を行わないでください。 これらの変更は、他の用途に充てるべきコンピューティング時間を浪費します。 ビルドの正確性、互換性、信頼性、または再現性を向上させる変更は、インストールされているファイルが変更されていないという理由だけで、単純とは見なされません。
固有のポート名を使用する
ポートの名前は、その内容を示す必要があります。
検索エンジンまたは Repology などの特殊なパッケージ ブラウザーでポートの名前を検索すると、対応するコンポーネントにつながるはずです。
短い名前または一般的な単語の名前が付いたポートでは、曖昧さの解消が必要です。 これは、キュレーションされたレジストリ内のポートの名前にのみ適用されます。パッケージ化されたコンポーネントの名前とその内容は、このポリシーに準拠する必要はありません。
そのポート名と密接に関連するコンポーネントをパッケージ化しているポートについては、例外が認められます。 例えば: libpng、openssl、またはzlib。
このポリシーに準拠するために、あいまいな名前を持つ新しいポートでは、次のようなプレフィックスを使用できます。
- リポジトリの所有者、ユーザー名、または組織。 例:
google-cloud-cpp。 GitHub でホストされているコンポーネントのポートについては、GitHub の所有者を<github owner>-<repository name>とする明確なプレフィックスとして使用できます。 - パッケージが属するスイートの名前:
boost-dll。 パッケージがそのようなスイートの公式コンポーネントである場合にのみ。
例: あいまいなポート名
ipという名前のポートは、次の理由であいまいと見なされます。
- 名前が短すぎます。
- 名前は一般的な単語であり、
- 名前はどの単一のコンポーネントにも強く関連付けられていません。
名前があいまいかどうかを判断するには、C++ および オープンソース コンポーネントで使用される次の一般的なプレフィックスとサフィックスをポート名から削除します。
cppfreelibopen- 数字
たとえば、 ip-cpp、 libip 、 ip5は、同じ ip 語幹に縮小されるため、あいまいです。
ポート名の変更を制限する
ユーザーの混乱を避けるために、ポートの名前は12か月の期間内に1回を超えて変更してはなりません。
GitHub ドラフト PR を使用する
GitHub Draft PR は、まだマージする準備ができていない作業に関する CI または人間のフィードバックを得るための優れた方法です。 ほとんどの新しい PR は下書きとして開き、CI が通過したら通常の PR に変換する必要があります。
GitHub ドラフト PR の詳細については、「 ドラフトプルリクエストの紹介」を参照してください。
vcpkg メンテナは、通常、レビュー プロセス中に PR を下書きに変換することがあります。通常、変更を要求するときや、PR をレビューの準備完了としてマークするタイミングを示すコメントを残す場合に行われます。
非アクティブな PR を閉じる
vcpkg のメンテナーは、共同作成者からの対応を 60 日以上待っても何も反応がない場合、その PR をクローズすることがあります。 非アクティブ状態のカウントダウンは、共同作成者による操作が必要な間のみ進行します。 PR がビルド ラボの検証を待機している間、または vcpkg メンテナによるレビューを待機している間は実行されません。
PR は、次の場合にレビュー可能な状態になります。
- PR チェックに不合格がないか、あるいは共同作成者が助けを求めるか、不合格の理由を説明している。
- vcpkg メンテナーからの変更や明確化の要求が保留されているものはありません。
- マージの競合はありません。
カウントダウンは、PR がコントリビューターの対応を必要とする状態になったときに開始されます。 これは、共同作成者が対処する必要がある問題で PR が開かれた場合、または vcpkg メンテナが変更または明確化を要求した場合に発生する可能性があります。 vcpkg のメンテナーは、共同作成者に何らかの対応を要求する際、PR を「下書き」としてマークすることができます。
共同作成者からの実質的な応答があると、カウントダウンがリセットされます。 応答が保留中のすべての要求を解決し、PR がレビューの準備ができている場合は、コントリビューターのアクションが再度必要になるまでカウントダウンが停止します。 対応が必要なにもかかわらず、共同作成者が 60 日以内に返答しない場合、その PR は放置されたものとみなされ、vcpkg のメンテナーの判断でクローズされる可能性があります。
ポートファイル
非推奨のヘルパー関数を回避する
現時点では、次のヘルパーは非推奨となっています。
-
vcpkg_extract_source_archive_ex()は、サポートされているオーバーロードのvcpkg_extract_source_archive()に置き換える必要がある (ARCHIVEを使用) -
vcpkg_extract_source_archive()のないARCHIVEの非推奨のオーバーロードは、ARCHIVEでサポートされているオーバーロードに置き換える必要があります。 -
vcpkg_apply_patches()は、"extract" ヘルパーのPATCHES引数に置き換える必要があります (例:vcpkg_from_github()) -
vcpkg_build_msbuild()をvcpkg_install_msbuild()に置き換える必要があります。 -
vcpkg_copy_tool_dependencies()をvcpkg_copy_tools()に置き換える必要があります。 -
vcpkg_configure_cmake削除後にvcpkg_cmake_configure()に置き換える必要がありますPREFER_NINJA -
vcpkg_build_cmakeをvcpkg_cmake_build()に置き換える必要があります。 -
vcpkg_install_cmakeをvcpkg_cmake_install()に置き換える必要があります。 -
vcpkg_fixup_cmake_targetsをvcpkg_cmake_config_fixupに置き換える必要があります。
一部の置換ヘルパー関数は、コンシューマーが特定のバージョンで動作をピン留めし、特定のバージョンでヘルパーの動作をロックできるようにするための "ツール ポート" にあります。 次のように、ツール ポートをポートの "dependencies"に追加する必要があります。
{
"name": "vcpkg-cmake",
"host": true
},
{
"name": "vcpkg-cmake-config",
"host": true
}
ポートファイル内の過剰なコメントを避ける
理想的には、ポートファイルは短く、単純で、可能な限り宣言型にする必要があります。
PR を送信する前に、 create コマンドによって導入されたボイラー プレートコメントを削除します。
16 進数の文字列に小文字を使用する
vcpkg の機能の多くは、16 進数の文字列の比較に依存しています。 例としては、SHA512 ハッシュ、Git コミット ID、ツリー オブジェクト ハッシュなどがありますが、これらに限定されません。
内部的には、vcpkg は、大文字と小文字が区別されない値の比較で小文字の正規化を使用します。 ただし、vcpkg のインフラストラクチャ上に構築されたツールでは、同じ考慮事項が発生しない場合があります。 このため、16 進数の文字列が必要です
次のシナリオでは、一貫性を保つために小文字にする必要があります。
- vcpkg ヘルパー関数の
SHA512パラメーター。 - vcpkg ヘルパー関数の
REFパラメーター (値が 16 進数の文字列の場合)。 -
git-tree内の オブジェクト。 -
sha512ファイル内のscripts/vcpkg-tools.jsonオブジェクト。 - 16 進文字列の大文字と小文字が重要でないその他の場所。
ポートはパスに依存してはなりません
ポートは、既にインストールされているポートに基づいて動作を変更し、その結果としてインストールする内容が変わるようなことはあってはなりません。 次に例を示します。
> vcpkg install a
> vcpkg install b
> vcpkg remove a
および
> vcpkg install b
bによってインストールされたファイルは、aの以前のインストールによる影響に関係なく、同じである必要があります。 つまり、ポートは、何らかのアクションを実行する前に、別のポートによってインストールされたツリーに何かが提供されているかどうかを検出しようとしないでください。 このような "パス依存" 動作の具体的で一般的な原因については、以下の「機能を定義する場合、依存関係を明示的に制御する」で説明します。
一意のポート属性ルール
vcpkg システム全体では、ユーザーが同時に使用する必要がある 2 つのポートが同じファイルを提供する可能性はありません。 ポートが別のポートによって既に提供されているファイルをインストールしようとすると、インストールは失敗します。 たとえば、ポートでヘッダーに非常に一般的な名前を使用する場合は、それらのヘッダーを includeではなくサブディレクトリに配置する必要があります。
このプロパティは、レジストリにすべてのポートをインストールしようとする継続的インテグレーション実行によって定期的にチェックされます。これは、2 つのポートが同じファイルを提供する場合、 FILE_CONFLICTS で失敗します。
非公式の名前空間に CMake エクスポートを追加する
vcpkg の中心的な設計の理想は、ユーザーに対して "ロックイン" を作成しないことです。 ビルド システムでは、システムのライブラリに依存することと、vcpkg のライブラリに依存することに違いはありません。 そのため、CMake エクスポートまたはターゲットを既存のライブラリに "わかりやすい名前" で追加することは避け、アップストリームは vcpkg と競合することなく独自の公式の CMake エクスポートを追加できます。
そのため、ポートがエクスポートする CMake 構成のうち、アップストリーム ライブラリにないものには、プレフィックスとして unofficial- を付ける必要があります。 追加のターゲットは、 unofficial::<port>:: 名前空間に存在する必要があります。
これは、ユーザーに次の情報が表示されることを意味します。
- vcpkg に特有のパッケージを取得する方法としての
find_package(unofficial-<port> CONFIG) -
unofficial::<port>::<target>そのポートからエクスポートされたターゲットとして。
例 :
-
brotliはunofficial-brotliパッケージを作成し、ターゲットunofficial::brotli::brotliを生成します。
著作権ファイルをインストールする
各ポートは、フォルダー copyrightに ${CURRENT_PACKAGES_DIR}/share/${PORT} という名前のファイルを提供する必要があります。 パッケージのライセンス コンテンツをソース ファイル内で使用できる場合は、 vcpkg_install_copyright()の呼び出しによってこのファイルを作成する必要があります。
vcpkg_install_copyright また、必要に応じて複数の著作権ファイルをバンドルします。
vcpkg_install_copyright(FILE_LIST "${SOURCE_PATH}/LICENSE")
このファイルを手動で作成する古い方法は、CMake の組み込みの file コマンドです。 これは、新しいポートでの vcpkg_install_copyright を優先することはお勧めしませんが、引き続き許可されます。
file(INSTALL "${SOURCE_PATH}/LICENSE" DESTINATION "${CURRENT_PACKAGES_DIR}/share/${PORT}" RENAME copyright)
アップストリーム ソース ファイル内のライセンス コンテンツがテキスト形式 (PDF ファイルなど) にない場合は、 copyright ユーザーがライセンス要件を見つける方法に関する説明を含める必要があります。 可能であれば、これを示す元のソース ファイルへのリンクも含める必要があるため、ユーザーは最新かどうかを確認できます。
file(WRITE "${CURRENT_PACKAGES_DIR}/share/${PORT}/copyright" [[As of 2023-07-25, according to
https://github.com/GPUOpen-LibrariesAndSDKs/display-library/blob/master/Public-Documents/README.md#end-user-license-agreement
this software is bound by the "SOFTWARE DEVELOPMENT KIT LICENSE AGREEMENT" PDF located at
https://github.com/GPUOpen-LibrariesAndSDKs/display-library/blob/master/Public-Documents/ADL%20SDK%20EULA.pdf
]])
ポートのバージョン制約
ポート内のバージョン制約は、コンポーネントの独立した進化を妨げる可能性があるため、通常は避ける必要があります。 このような制約の追加は、特定の以前のバージョンとの互換性がない実証済みなど、適切に文書化された正当な理由がある場合にのみ許容されます。 これらの制約は、独立したコンポーネントとのパリティを維持するためだけに使用するべきではありません。
MAYBE_UNUSED_VARIABLES内の変数は、少なくとも 1 つの構成に適用する必要があります
CMake 構成手順中に警告を無音にするために新しい変数を MAYBE_UNUSED_VARIABLES に追加する場合は、新しい変数が適用されたときのケースを説明するコメントを追加する必要があります。 ある変数がどの構成でも適用されない場合、根本的なバグ (変数名のスペルミスなど) が存在している可能性が非常に高く、その変数を追加してもビルドには実質的な影響はありません。
vcpkg_check_features(OUT_FEATURE_OPTIONS FEATURE_OPTIONS
FEATURES
windowsfeature WINDOWS_OPTION
)
vcpkg_cmake_configure(
SOURCE_PATH "${SOURCE_PATH}"
OPTIONS
${FEATURE_OPTIONS}
MAYBE_UNUSED_VARIABLES
WINDOWS_OPTION # Applies only on Windows
)
機能
機能を使用して代替手段を実装しない
特徴は追加機能として扱う必要があります。
port[featureA]をインストールし、port[featureB]をインストールする場合は、port[featureA,featureB]をインストールする必要があります。 さらに、2 つ目のポートが [featureA] に依存し、3 つ目のポートが [featureB]に依存している場合は、2 番目と 3 番目のポートの両方をインストールすると、依存関係が満たされている必要があります。
この状況のライブラリでは、vcpkg で表される使用可能なオプションのいずれかを選択する必要があり、別の設定を必要とするユーザーは、現時点でオーバーレイ ポートを使用する必要があります。
旧バージョンとの互換性を保つために、現在は受け入れられない既存の例:
-
libgit2libzip、open62541はすべて、TLS または暗号化バックエンドを選択するための機能を備えています。curlには異なる暗号化バックエンド オプションがありますが、実行時に選択できます。つまり、上記のテネットが維持されます。 -
darknetには、依存関係に使用する opencv のバージョンを制御するopencv2、opencv3機能があります。
機能はプレビュー機能またはベータ版の機能を利用する場合があります
上記にかかわらず、プレビュー機能がプレビュー以外の機能 (API の削除なしなど) を中断しない可能性が高いプレビュー ブランチなどがある場合は、この設定をモデル化できます。
例 :
- (フォーム
azure-Xxxの) Azure SDK には、public-preview機能があります。 -
imguiには、公開番号付きリリースごとに添付されたマージ コミットを使用するプレビュー ドッキング ブランチを使用するexperimental-docking機能があります。
既定の機能では API を追加できません
注
アップストリーム ビルド システムによって既定で有効になっている機能は、その機能を default-features エントリに追加する必要があることを意味するものではありません。
default-featuresの目的は、アップストリームによって行われた決定をモデル化するのではなく、クラシック モードのユーザーに利便性を提供することです。
既定の機能は、ライブラリを使用していることを知らないお客様に対して、ライブラリの合理的に機能的なビルドが確実にインストールされるようにするためのものです。 ライブラリを使用していることを知らない場合は、機能を一覧表示することはできません。 たとえば、 libarchive は、圧縮アルゴリズムを有効にする機能を既存の汎用インターフェイスに公開します。そのような機能を使用せずにビルドされた場合、ライブラリにはユーティリティがない可能性があります。
ここでは、顧客には、パッケージ グラフを利用するユーザー プロジェクトと、そのグラフ内のダウンストリーム ポートの両方が含まれます。 どちらも、同じ機能インターフェイスを通じて依存関係の要件を表します。
既定の機能を無効にするのは複雑であるため、機能を既定でオンにすべきかどうかを慎重に検討してください。
推移的な依存関係の既定の機能を無効にするには:
- ポートに依存するすべての利用側は、
"default-features": falseを使用して依存関係宣言で既定の機能を無効にする必要があります。 - また、最上位のプロジェクトでは、マニフェスト内で
"default-features": falseを指定するか、vcpkg installコマンドラインで[core]を指定することで、推移的依存関係を直接指定する必要があります。
既定の機能を無効にしても、他のお客様がこれらの機能を明示的に要求することを防ぐことはありません。
このポリシーでは、API は、ライブラリ インターフェイス、実行可能コマンド ライン インターフェイス、およびその他のバイナリ インターフェイスなど、コンシューマーに公開される任意のインターフェイスです。 既存の API の背後で動作を追加する場合、その機能はデフォルトで有効になっていることがあります。例えば、既存の汎用インターフェースを通じて追加の圧縮アルゴリズムをサポートする場合などが挙げられます。
vcpkg のキュレーション レジストリでは、機能によって API が追加される場合は、既定でオフになっている必要があります。 不明な場合は、機能を既定としてマークしないでください。
発行済みインターフェイスの代替機能を制御するために機能を使用しない
ポートのコンシューマーがそのポートのコア機能のみに依存している場合、機能をオンにしても問題が生じることはほぼ避けなければなりません。 これは、代替手段がコンシューマーによって直接制御されるのではなく、 /std:c++17 / -std=c++17などのコンパイラ設定によって制御される場合にさらに重要になります。
旧バージョンとの互換性を保つために、現在は受け入れられない既存の例:
-
redis-plus-plus[cxx17]はポリフィルを制御しますが、設定をインストール済みのツリーにベイクしません。 -
ace[wchar]は、const wchar_t*ではなくconst char*を受け入れるようにすべての API を変更します。
インストールされたツリーに置き換えが組み込まれている場合、機能によりポリフィルがエイリアスで置き換えられる場合があります
上記にかかわらず、ポートは、次の場合に限り、機能を備えたポリフィルを削除できます。
- この機能をオンにすると、ポリフィルがポリフィルされたエンティティのエイリアスに変更されます
- ポリフィルの状態はインストールされたヘッダーに組み込まれているため、ABI の不一致による "不可能な" ランタイムエラーが発生する可能性は低い。
- ポートのコンシューマーは、たとえば、ポリフィルされた typedef を使用するかどうかにかかわらず、両方のモードで機能するコードを書くことができます。
例:
-
abseil[cxx17]はabsl::string_viewを置換またはstd::string_viewに変更します。パッチはベーキング要件を実装します。
推奨されるソリューション
基になる代替手段を公開することが重要な場合は、ビルド時にメッセージを提供して、プライベート オーバーレイにポートをコピーする方法をユーザーに指示することをお勧めします。
set(USING_DOG 0)
message(STATUS "This version of LibContoso uses the Kittens backend. To use the Dog backend instead, create an overlay port of this with USING_DOG set to 1 and the `kittens` dependency replaced with `dog`.")
message(STATUS "This recipe is at ${CMAKE_CURRENT_LIST_DIR}")
message(STATUS "See the overlay ports documentation at https://github.com/microsoft/vcpkg/blob/master/docs/specifications/ports-overlay.md")
ビルド手法
ベンダーの依存関係を使用しない
ユーザーが vcpkg を使用して依存関係を選択して更新できるように、依存関係は個別にパッケージ化することを推奨します。 ベンダリングされた依存関係では、いくつかの課題が発生します。
- 更新の難しさ: ベンダーの依存関係は、セキュリティ修正プログラムの適用時を含め、追跡と更新が困難です。
- シンボルの競合: ベンダー提供の依存関係が、その依存関係の別のバージョンと同じシンボルを定義している場合、実行時エラーや未定義の挙動を引き起こす可能性があります。
- ライセンス コンプライアンス: 同梱された依存関係によって、ライセンス要件があいまいになったり、ライセンスの互換性の問題が発生したりする可能性があります。
- メンテナンスの増加: ベンダーの依存関係をアップストリーム バージョンと同期すると、メンテナンス作業が増加し、ポート間で作業が重複する可能性があります。
こうした理由から、可能な限りベンダーへの依存を避けるべきです。 ベンダー提供の依存関係は、ユーザーのリンク ドメインに公開してはなりません。
リンク ドメインは、実行時に相互に解決できるシンボルのセットです。 Windowsでは、通常、各 DLL には独自のリンク ドメインがあります。 プロセス全体のシンボルテーブルを持つプラットフォームでは、リンク ドメインには通常、プロセス全体が含まれます。
コンポーネントが vcpkg で選択した依存関係と同じリンク ドメインにベンダー依存関係を公開する場合、両方のコピーで同じシンボルを定義できます。 これは One Definition Rule(ODR)に違反し、実行時エラーや未定義の動作を引き起こす可能性があります。 この問題は、2 つのバージョンの差異が大きく、互換性がなくなる場合にのみ発生する可能性があります。
同梱された依存関係は、ダウンストリーム ポートとユーザー アプリケーションによって使用されるリンク ドメインから完全に分離されている場合にのみ許可されます。 たとえば、ダウンストリーム バイナリがそのツールにリンクせず、依存関係のシンボルがリンク ドメインに入ることができない場合、ホスト専用ビルド ツールには静的にリンクされた依存関係を含めることができます。
CMake の使用を優先する
複数のビルドシステムが使用可能な場合は、CMake を使用することをお選び下さいます。
さらに、必要に応じて、 file(GLOB) ディレクティブを使用して代替ビルドシステムを CMake に書き換える方が簡単で保守しやすくなります。
例: abseil
静的バイナリまたは共有バイナリを選択する
CMake ライブラリをビルドするときに、 vcpkg_cmake_configure() は、ユーザーの要求されたバリアントに基づいて、 BUILD_SHARED_LIBS の正しい値を渡します。
string(COMPARE EQUAL "${VCPKG_LIBRARY_LINKAGE}" ...)を使用して、代替構成パラメーターを計算できます。
# portfile.cmake
string(COMPARE EQUAL "${VCPKG_LIBRARY_LINKAGE}" "static" KEYSTONE_BUILD_STATIC)
string(COMPARE EQUAL "${VCPKG_LIBRARY_LINKAGE}" "dynamic" KEYSTONE_BUILD_SHARED)
vcpkg_cmake_configure(
SOURCE_PATH ${SOURCE_PATH}
OPTIONS
-DKEYSTONE_BUILD_STATIC=${KEYSTONE_BUILD_STATIC}
-DKEYSTONE_BUILD_SHARED=${KEYSTONE_BUILD_SHARED}
)
ライブラリでビルド バリアントを選択するための構成オプションが提供されていない場合は、ビルドに修正プログラムを適用する必要があります。 ビルドにパッチを適用する場合は、常にポートの将来の保守性を最大限に高める必要があります。 通常、これは、目の前の問題を解決するためにタッチする必要がある行の数を最小限にすることを意味します。
例: 不要なバリアントを構築しないように CMake ライブラリにパッチを適用する
たとえば、CMake ベースのライブラリにパッチを適用する場合、不要なターゲットに EXCLUDE_FROM_ALL を追加し、 install(TARGETS ...) 呼び出しを if(BUILD_SHARED_LIBS)でラップするだけで十分な場合があります。 これは、不要なバリアントに言及するすべての行を折り返したり削除したりするよりも短くなります。
次の内容を含むプロジェクト CMakeLists.txt の場合:
add_library(contoso SHARED contoso.c)
add_library(contoso_static STATIC contoso.c)
install(TARGETS contoso contoso_static EXPORT ContosoTargets)
install(EXPORT ContosoTargets
FILE ContosoTargets
NAMESPACE contoso::
DESTINATION share/contoso)
install(TARGETS)行を、既定のビルドから不要なターゲットも除外する条件付きブロックに置き換えます。
add_library(contoso SHARED contoso.c)
add_library(contoso_static STATIC contoso.c)
if(BUILD_SHARED_LIBS)
set_target_properties(contoso_static PROPERTIES EXCLUDE_FROM_ALL 1)
install(TARGETS contoso EXPORT ContosoTargets)
else()
set_target_properties(contoso PROPERTIES EXCLUDE_FROM_ALL 1)
install(TARGETS contoso_static EXPORT ContosoTargets)
endif()
install(EXPORT ContosoTargets
FILE ContosoTargets
NAMESPACE contoso::
DESTINATION share/contoso)
機能を定義する場合は、依存関係を明示的に制御します
オプションの依存関係をキャプチャする機能を定義する場合は、機能が明示的に有効になっていないときに依存関係が誤って使用されないようにします。
set(CMAKE_DISABLE_FIND_PACKAGE_ZLIB ON)
set(CMAKE_REQUIRE_FIND_PACKAGE_ZLIB OFF)
if ("zlib" IN_LIST FEATURES)
set(CMAKE_DISABLE_FIND_PACKAGE_ZLIB OFF)
set(CMAKE_REQUIRE_FIND_PACKAGE_ZLIB ON)
endif()
vcpkg_cmake_configure(
SOURCE_PATH ${SOURCE_PATH}
OPTIONS
-DCMAKE_DISABLE_FIND_PACKAGE_ZLIB=${CMAKE_DISABLE_FIND_PACKAGE_ZLIB}
-DCMAKE_REQUIRE_FIND_PACKAGE_ZLIB=${CMAKE_REQUIRE_FIND_PACKAGE_ZLIB}
)
vcpkg_check_features()を使用する次のスニペットは同等です。
vcpkg_check_features(OUT_FEATURE_OPTIONS FEATURE_OPTIONS
FEATURES
"zlib" CMAKE_REQUIRE_FIND_PACKAGE_ZLIB
INVERTED_FEATURES
"zlib" CMAKE_DISABLE_FIND_PACKAGE_ZLIB
)
vcpkg_cmake_configure(
SOURCE_PATH ${SOURCE_PATH}
OPTIONS
${FEATURE_OPTIONS}
)
スニペットの ZLIB では大文字と小文字が区別されます。 詳細については、 CMAKE_DISABLE_FIND_PACKAGE_<PackageName> と CMAKE_REQUIRE_FIND_PACKAGE_<PackageName> のドキュメントを参照してください。
競合する lib を manual-link ディレクトリに配置する
.lib または .a にインストールされている、.so、.dylib、lib、または debug/lib ファイルなどのリンカー入力ファイルは、次のいずれかに該当する場合、競合していると見なされます。
-
mainを定義します。 -
mallocを定義します。 - 他のライブラリでも定義されているシンボルを定義します。
一部のリンカー入力ファイルでは、コンシューマーが他の場所で定義または取得するシンボルに対して、意図的に狭い範囲の置換が提供されます。 たとえば、Google Test の gtest-main.lib は、作成者が独自のエントリ ポイントを定義する代わりにこれを使用することを選択したテスト実行可能ファイルに対して、main を提供します。
競合するリンカー入力ファイルを lib/manual-link または debug/lib/manual-link に配置して、ライブラリ ディレクトリからファイルを自動的にリンクするビルド システムによってそれらが選択されないようにします。 Windows DLL は bin または debug/bin に残ります。明示的なリンクが必要な場合は、それらのインポート ライブラリを manual-link に配置します。 コンシューマーはこれらのファイルをリンクすることに明示的に同意する必要があり、競合する定義を回避する責任があります。 この例外は、別のコンポーネントの代替プロバイダーをパッケージ化するための一般的なメカニズムではなく、リンカー入力ファイルを manual-link に移動しても、そのシンボルがコンシューマーのリンク ドメインから分離されることはありません。
事前構築済みバイナリのインストール
事前構築済み (バイナリのみ) の成果物をインストールするポートは許可されますが、その成果物によってユーザーが vcpkg を介した依存関係の選択や更新を妨げられないことを条件に、強く非推奨です。 ソースからのビルドは、コンパイラとフラグを制御する vcpkg 設定を考慮しているため、推奨されます。
次のすべての条件を満たすポートは拒否されます。
- ソースからビルドするのではなく、事前構築済みのバイナリをインストールし、
- これらのバイナリは、キュレーションされたレジストリ内の他のポートによって提供される実行時の依存関係を組み込むか、または必要とし、
- インストールされたアーティファクトは、それらの依存関係をリンク ドメインに公開します。このリンク ドメインには、vcpkg を通じて選択されたバージョンも含まれる場合があります。
この組み合わせにより、アップストリームの事前構築済みビルド時に使用されたバージョンに対して依存関係グラフが効果的にロックされます。
vcpkg が zlib や openssl などの依存関係を更新する場合、事前構築済みバージョンとユーザーが選択したバージョンでは、同じリンク ドメイン内に互換性のないシンボルを定義してしまう可能性があります。 これにより、One Definition Rule 違反、ABI の非互換性、またはセキュリティ更新プログラムが見逃される可能性があります。
アーティファクトは、その依存関係がユーザーのリンク ドメインに関与している場合、アップストリームがその依存関係を公開する意図があるかどうかにかかわらず、その依存関係を公開します。 これには、以下のことが含まれます。
- コンシューマーからリンク可能な
.lib、.a、.so、.dylibあるいは依存関係をユーザーのリンク領域に取り込むインポート ライブラリ。 - 他の vcpkg ポートからシンボル、型、またはマクロを参照する (直接またはインライン/テンプレート コードを使用して) インストールされたヘッダー。
- 他の vcpkg ポートで
find_dependency()またはRequires:を呼び出すインストール済みの CMake 構成ファイルまたは pkg-config ファイル。
許可されている (ただし推奨されない) シナリオ:
- バンドルされた依存関係を分離したり、ユビキタスなシステム ランタイム ライブラリのみに依存したりする限り、出力が消費されるが依存ポートによってリンクされていない、ビルド時に使用されるホスト専用ヘルパー ツール。
- バンドルされた依存関係が完全に個別のリンク ドメインに残り、インストールされているヘッダーやエクスポートされたインターフェイスに表示されない事前構築済みライブラリ。 静的リンクだけでは、ユーザーのリンク ドメインから依存関係が分離されることはありません。
- ユーザーコードにリンクされていないデータのみ、ファームウェア、およびアセットパッケージ。
禁止されている例:
-
zlibのプライベート コピーを静的にリンクし、そのシンボルを、vcpkg で選択されたzlibバージョンも含むことができるリンク ドメインに公開する事前構築済みライブラリ。 -
libfooという既製のライブラリは、lib/libfoo.libおよび<zlib.h>を含むヘッダー ファイルをインストールし、特定のzlibバージョンに対してコンパイルされています。利用者は、互換性を期待してlibfooに対してリンクを行います。 - バイナリが以前の OpenSSL リリースに対してコンパイルされている間に
find_dependency(OpenSSL)を呼び出す CMake パッケージ ファイルをインストールする事前構築済み SDK。
軽減策/代替手段:
- アップストリーム スクリプトを使用してソースからのビルドを提供するか、薄いCMakeラッパーを追加します。
- ソース ベースのリリースまたは再現可能なビルド命令を公開するようにアップストリームに依頼します。
portfile.cmakeまたはvcpkg.jsonのコメントでアップストリームの問題/PR をリンクします。 - これらの規則を満たすことができない組織固有の事前構築済みには、 オーバーレイ ポート またはプライベート レジストリを使用します。
バージョン管理
"version" フィールドの一般的な規則に従う
新しいポートを作成するときは、パッケージ作成者が使用するバージョン管理規則に従ってください。 ポートを更新する場合は、アップストリームで特に断りがない限り、引き続き同じ規則を使用します。 規則の詳細については、 バージョン管理に関するドキュメントを参照してください。
アップストリームがしばらくリリースを公開していない場合は、最新の変更を取得するために、ポートのバージョン管理スキームを version-date に変更しないでください。 これらのコミットには、運用環境の準備ができていない変更が含まれる場合があります。 代わりに、アップストリーム リポジトリに新しいリリースを発行するよう依頼してください。
変更されたすべてのポートの "port-version" フィールドを更新する
ポートを変更する各 PR は、そのポートの新しいバージョンを生成する必要があります。 PR はスカッシュ マージされるため、変更された各ポートのバージョンは、コミットまたはレビュー リビジョンごとに 1 回ではなく、PR ごとに 1 回更新します。
アップストリーム バージョンが変更されていない場合は、"port-version" フィールドをインクリメントしてください。 アップストリームのバージョンが変更された場合は、そのフィールドを削除するか、0 に設定して "port-version" を 0 にリセットします。
例:
- Zlib のパッケージバージョンは現在
1.2.1です。明示的な"port-version"はなく、これは"port-version"の0に相当します。 - 間違った著作権ファイルがデプロイされていることを発見し、ポートファイル内で修正しました。
- マニフェスト ファイルの
"port-version"フィールドを1に更新する必要があります。
詳細については、 バージョン管理のドキュメント を参照してください。
変更されたすべてのポートについて、 versions/ のバージョン ファイルを更新します
vcpkg は、一連のメタデータ ファイルを使用してバージョン管理機能を強化します。 これらのファイルは、次の場所にあります。
-
${VCPKG_ROOT}/versions/baseline.json、(このファイルはすべてのポートに共通です)、 -
${VCPKG_ROOT}/versions/${first-letter-of-portname}-/${portname}.json(ポートごとに 1 つ)。
たとえば、関連するファイル zlib 次のようになります。
${VCPKG_ROOT}/versions/baseline.json${VCPKG_ROOT}/versions/z-/zlib.json
PR で変更された各ポートについて、そのバージョン ファイルを更新して最終的な Git ツリーを記録します。 レビュー中にさらに変更を加えた場合は、vcpkg x-add-version <port-name> --overwrite-version を実行して、マージされていないバージョンのエントリを更新します
再び"port-version"をインクリメントせずに。
これらのファイルを更新するには、次のような x-add-version コマンドを実行することをお勧めします。
vcpkg x-add-version zlib
複数のポートを同時に更新する場合は、代わりに次のコマンドを実行できます。
vcpkg x-add-version --all
変更されたすべてのポートのファイルを一度に更新します。
詳細については、バージョン管理のリファレンス と レジストリの に関する記事を参照してください。
パッチを適用すること
vcpkg はパッケージ ソリューションであり、デプロイするコンポーネントの最終的な所有者ではありません。 場合によっては、コンポーネントとプラットフォームの互換性、またはコンポーネントの互換性を向上させるために、パッチを適用する必要があります。
- パッチのうち、以下を回避したいと考えています。
- アップストリームは同意しないでしょう
- 脆弱性やクラッシュを引き起こす
- アップストリーム バージョンの更新プログラム全体を維持することは不可能です
- は、vcpkg リポジトリ自体とライセンスの絡み合いを引き起こすのに十分な大きさです
アップストリームへの通知と待機期間
アップストリームの所有者は、そのコンポーネントの挙動について最終的な決定権を持っています。 vcpkg のメンテナーは、アップストリームに関連するパッチや、新しいポートの提出物において AI コード レビュー ツールによって検出されたバグについて、アップストリームへの通知を必要とします。
アップストリーム関連のパッチ
パッチがアップストリームで役立つ可能性がある場合、vcpkg のメンテナーは、そのパッチの内容についてアップストリームに通知する必要があります。 依存関係の非ベンダー化など、アップストリームとは無関係な vcpkg 固有の動作を適用するパッチについては、通知の必要はありません。
アップストリームがそのパッチに同意しない状況を回避するために、vcpkg 保守担当者は、アップストリームへの通知後、少なくとも 30 日待ってから、そのようなパッチを適用します。
vcpkg メンテナーは、変更が正しいと強い確信がある場合、この待機期間をスキップします。 信頼度の高いパッチの例としては、次のようなものがありますが、これらに限定されません。
- アップストリームでのパッチの受け入れ (アップストリームがマージした pull request から特定の変更をバックポートするなど)。
- 不足している
#includeを追加する。 - 小規模で明白な製品コードの修正 (初期化されていない変数の初期化など)。
- テストや例など、ビルドの無関係な vcpkg コンポーネントを無効にします。
新しいポートで AI が検出されたバグ
キュレーションされたレジストリは、既知の悪用可能なコードの配布を回避することを目的としていますが、vcpkg 保守担当者はすべてのコンポーネントのソース コードを包括的に監査することはできません。 AI コード レビューの結果は、それ自体では、アップストリーム コードが脆弱であるという最終的な決定ではありません。
新しいポートの申請のレビュー中に AI コード レビュー ツールでバグが特定されると、vcpkg の保守担当者は、潜在的に悪用可能なバグに対するプロジェクトのセキュリティ レポート プロセスに従って、バグをアップストリームに報告する必要があります。 この要件は、ポートがパッチを適用しないアップストリーム コードに関する場合でも適用されます。
- 報告された動作がバグではないとアップストリームが判断した場合、vcpkg メンテナはその決定を最終決定として受け入れ、その結果に基づいて新しいポートの提出を拒否しません。
- アップストリームがバグを修正した場合、vcpkg 保守担当者はパッチ適用ポリシーと新しいポートのその他の要件に従って、修正済みバージョンまたはアップストリームで承認されたパッチを受け入れます。
- バグが報告されてから 30 日経ってもアップストリームが応答しない場合、vcpkg 保守担当者は、既定で AI の検出を悪用可能な問題として扱い、新しいポートの提出をクローズします。
パッチ待機期間に関する「信頼度の高い」例外であっても、このバグ報告の要件や、アップストリームからの応答が必要であるという点は免除されません。
修正プログラムの適用よりもオプションを優先する
設定に直接パッチを適用するよりも vcpkg_configure_xyz() する呼び出しでオプションを設定することをお勧めします。
修正プログラムの適用を回避できる一般的なオプション:
- [MSBUILD]
<PropertyGroup>プロジェクト ファイル内の設定は、/p:パラメーターを使用してオーバーライドできます - [CMAKE] CMake スクリプトでの
find_package(XYz)の呼び出しは-DCMAKE_DISABLE_FIND_PACKAGE_XYz=ONによって無効にすることができます。 - [CMAKE]キャッシュ変数 (
set(VAR "value" CACHE STRING "Documentation")またはoption(VAR "Documentation" "Default Value")として宣言) は、コマンド ラインで-DVAR:STRING=Fooとして渡すだけでオーバーライドできます。 注目すべき例外の 1 つは、FORCEパラメーターがset()に渡される場合です。 詳細については、 CMakesetのドキュメントを参照してください。
承認されたパッチをダウンロードすることを、ポートへのチェックインよりも優先する
承認済みまたはマージ済みのパッチがアップストリームのコミットから入手できる場合は、それをポートにチェックインする代わりに、ダウンロードして適用してください。 このプロセスは次の理由で推奨されます。
- アップストリームがパッチの変更を受け入れたことを確認します。
- 負担を上流工程に移すことで、レビュー プロセスを簡略化します。
- そのパッチを使用しないユーザー向けに、vcpkg リポジトリのサイズを小さくします。
- vcpkg リポジトリとのライセンスの競合を回避します。
パッチは、完全なコミット ID にピン留めされた URL からのみダウンロードします。コンテンツが変更される可能性がある pull request または merge request diff URL からはダウンロードしません。 GitHubまたは GitLab からコミット パッチをダウンロードする場合は、URLの末尾に?full_index=1を追加します。 このパラメーターは、diff 内の完全なオブジェクト ID を要求します。変更可能な URL を不変にはしません。
例えば次が挙げられます。
VCPKG_<VARIABLE>値のオーバーライドよりも修正プログラムの適用を優先する
VCPKG_<VARIABLE>プレフィックスが付いた一部の変数には、同等のCMAKE_<VARIABLE>があります。
ただし、そのすべてが内部パッケージ ビルド (実装: Windows ツールチェーンを参照) に渡されるわけではありません。
次の例を確認してください。
set(VCPKG_C_FLAGS "-O2 ${VCPKG_C_FLAGS}")
set(VCPKG_CXX_FLAGS "-O2 ${VCPKG_CXX_FLAGS}")
vcpkgの組み込みツールチェーンを使用すると、VCPKG_<LANG>_FLAGSの値が適切なCMAKE_<LANG>_FLAGS変数に転送されるため、これは機能します。 ただし、 vcpkgの変数を認識していないカスタム ツールチェーンは、それらを転送しません。
このため、 CMAKE_<LANG>_FLAGS設定するときにビルドシステムに直接パッチを適用することをお勧めしています。
パッチを最小限に抑える
ライブラリに変更を加える場合は、最終的な差分を最小限に抑えるように努めます。 つまり、リージョンに影響を与える変更を行うときは、アップストリームのソース コードを再フォーマットしないでください。 条件付きを無効にする場合は、条件のすべての行を削除するよりも、条件に AND FALSE または && 0 を追加することをお勧めします。 大きなリージョンを無効にする必要がある場合は、パッチ内のすべての行を削除するのではなく、リージョンの周りに if(0) または #if 0 を追加する方が短くなります。
ポートが古く、ポートを新しいリリースバージョンに更新すると同じ問題が解決する場合は、パッチを追加しないでください。 vcpkg では、古いバージョンにパッチを適用するよりも、ポートの更新が優先されます。
これにより、vcpkg リポジトリのサイズを減らしながら、将来のコード バージョンにパッチが適用される可能性が向上します。
パッチに機能を実装しない
vcpkg で修正プログラムを適用する目的は、コンパイラ、ライブラリ、プラットフォームとの互換性を有効にすることです。 適切なオープン ソースの手順に従う代わりに新機能を実装する (問題/PR などを送信する) ためのものではありません。
既定ではテスト/ドキュメント/例をビルドしないでください
新しいポートを送信するときは、 BUILD_TESTS 、 WITH_TESTS 、 POCO_ENABLE_SAMPLES などのオプションを確認し、追加のバイナリが無効になっていることを確認します。 これにより、平均ユーザーのビルド時間と依存関係が最小限に抑えられます。
必要に応じて、テストのビルドを可能にする test 機能を追加できますが、これは Default-Features リストに含めてはなりません。
ライブラリの既存のユーザーが vcpkg に切り替えるようにする
追加しないでください CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS
ライブラリの作成者が既に使用している場合を除き、この CMake 機能は C++ テンプレートと十分に対話せず、特定のコンパイラ機能を中断するため、使用しないでください。 .def ファイルを提供せず、__declspec() 宣言を使用しないライブラリは、単に Windows の共有ビルドをサポートしていないため、次のようにマークする必要があります。
if(VCPKG_TARGET_IS_WINDOWS)
vcpkg_check_linkage(ONLY_STATIC_LIBRARY)
endif()
アップストリームによって指定された名前の外部にあるバイナリの名前を変更しないでください
つまり、アップストリーム ライブラリの名前がリリースとデバッグで異なる場合 (libx と libxd)、デバッグ ライブラリの名前を libx に変更しないでください。 逆に、アップストリーム ライブラリがリリースとデバッグで同じ名前を持つ場合は、新しい名前を導入しないでください。
重要な注意事項:
- 多くの場合、静的バリアントと共有バリアントの名前を共通スキームに変更する必要があります。 これにより、コンシューマーは共通名を使用し、ダウンストリーム リンケージを無視できます。 これは、一度に 1 つしか使用できないため、安全です。
ライブラリで CMake 統合ファイル (foo-config.cmake) が生成される場合は、単に出力アーカイブ/LIB で file(RENAME) を呼び出すのではなく、CMake ビルド自体に修正プログラムを適用して名前を変更する必要があります。
最後に、Windows 上の DLL ファイルは、生成された LIB を壊すので、ビルド後に名前を変更しないでください。
マニフェスト
マニフェスト ファイルを書式設定する必要があります。 すべてのマニフェスト ファイルを書式設定するには、次のコマンドを使用します。
> vcpkg format-manifest --all
三つ子
現時点では、コミュニティ以外のトリプレットを追加する要求は受け付けていません。 コミュニティから完全なトリプレット状態への昇格は、主にハードウェアがこのようなトリプレットをテストするための予算に基づいており、実際に使用するものが完全にテストされる可能性を最大化するために vcpkg によって送信されたメトリックによって駆動されます。
以下の場合、コミュニティトリプレットを追加します。
- 人々が実際にそのコミュニティ トリプレットを使用することが実証されています。
- 私たちは、そのような三重項が壊れていることを知らない。
たとえば、 https://github.com/microsoft/vcpkg/pull/29034 にトリプレットを追加しませんでした。これは、作成者が実際にそのようなものを使用することを示すのではなく、単に "セットを完了" しようとしていただけであり、結果を再配置可能にするために patchlf ソリューションが作成されるまで linux-dynamic を追加しませんでした。
便利な実装に関する注意事項
ポートファイルはスクリプト モードで実行されます
portfile.cmakeとCMakeLists.txtは共通の構文とコア CMake 言語コンストラクト ("Scripting Commands") を共有していますが、ポートファイルは "スクリプト モード" で実行されますが、CMakeLists.txt ファイルは "プロジェクト モード" で実行されます。 これら 2 つのモードの最も重要な違いは、"スクリプト モード" には "Toolchain"、"Language"、"Target" という概念が含まれていないということです。 これらのコンストラクト ( CMAKE_CXX_COMPILER、 CMAKE_EXECUTABLE_SUFFIX、 CMAKE_SYSTEM_NAME など) に依存するスクリプト コマンドを含む動作は正しくありません。
Portfile はトリプレット ファイルで設定された変数に直接アクセスできますが、 CMakeLists.txtにはアクセスできません (ただし、多くの場合、変換が行われますが、 VCPKG_LIBRARY_LINKAGE と BUILD_SHARED_LIBS)。
ポートファイルによって呼び出されるポートファイルとプロジェクト ビルドは、異なるプロセスで実行されます。 概念的に言えば
+----------------------------+ +------------------------------------+
| CMake.exe | | CMake.exe |
+----------------------------+ +------------------------------------+
| Triplet file | ====> | Toolchain file |
| (x64-windows.cmake) | | (scripts/buildsystems/vcpkg.cmake) |
+----------------------------+ +------------------------------------+
| Portfile | ====> | CMakeLists.txt |
| (ports/foo/portfile.cmake) | | (buildtrees/../CMakeLists.txt) |
+----------------------------+ +------------------------------------+
ポートファイル内のホストを特定するために、標準の CMake 変数は問題ありません (CMAKE_HOST_WIN32)。
ポートファイル内のターゲットを決定するには、vcpkg triplet 変数を使用する必要があります (VCPKG_CMAKE_SYSTEM_NAME)。
使用可能な設定の完全な列挙については、 triplet のドキュメント も参照してください。
vcpkg