新しいCMakeポリシー CMP0141：MSVCデバッグ情報フォーマットの互換性を向上

CMakeポリシー CMP0141は、CMake 3.25で導入された新しいポリシーで、MSVCデバッグ情報フォーマットの扱いに関する互換性を提供します。

背景

CMake 3.24 以前では、デバッグ情報フォーマットフラグは自動的にデフォルトの CMAKE_<LANG>_FLAGS_<CONFIG> キャッシュエントリに追加されていました。しかし、CMake 3.25 以降では、これらのフラグはデフォルト値から除外され、代わりに抽象化された方法で提供されるようになりました。

CMP0141 の役割

CMP0141ポリシーは、以下の2つの動作を切り替えます。

OLD 動作 (CMake 3.24 以前と同じ)

• MSVCデバッグ情報フォーマットフラグがデフォルトの CMAKE_<LANG>_FLAGS_<CONFIG> キャッシュエントリに追加されます。
• CMAKE_MSVC_DEBUG_INFORMATION_FORMAT 変数は無視されます。

NEW 動作 (CMake 3.25 以降のデフォルト)

• CMAKE_MSVC_DEBUG_INFORMATION_FORMAT 変数を使用して、デバッグ情報フォーマットを選択できます。

設定方法

CMP0141ポリシーは、cmake_policy() コマンドを使用して設定できます。

cmake_policy(CMP0141 NEW)

影響を受けるプロジェクト

以下のプロジェクトは、CMP0141ポリシーの影響を受けます。

• CMake 3.24 以前で作成されたプロジェクト
• CMAKE_MSVC_DEBUG_INFORMATION_FORMAT 変数を使用するプロジェクト
• MSVCデバッグ情報フォーマットフラグを明示的に設定するプロジェクト

互換性の維持

CMP0141ポリシーは、CMake 3.24 以前で作成されたプロジェクトとの互換性を維持するために提供されています。プロジェクトを CMake 3.25 以降に移行する場合は、このポリシーを設定する必要があります。

CMP0141ポリシーの詳細については、以下のリソースを参照してください。

補足

• CMP0141ポリシーは、MSVCコンパイラのみを対象としています。
• デバッグ情報フォーマットの詳細については、MSVCドキュメントを参照してください。

CMakeポリシー CMP0141 のサンプルコード

CMake 3.24 以前のプロジェクト

# デバッグ情報フォーマットを "CodeView" に設定
set(CMAKE_C_FLAGS_DEBUG "/Zi")
set(CMAKE_CXX_FLAGS_DEBUG "/Zi")

# プロジェクトのビルド
add_executable(my_project main.c)

CMake 3.25 以降のプロジェクト

# CMake 3.25 以降のデフォルト動作を使用
cmake_policy(CMP0141 NEW)

# デバッグ情報フォーマットを "CodeView" に設定
set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "CodeView")

# プロジェクトのビルド
add_executable(my_project main.c)

CMP0141ポリシーの有効化/無効化

# CMP0141ポリシーを有効にする
cmake_policy(CMP0141 OLD)

# デバッグ情報フォーマットを "CodeView" に設定
set(CMAKE_C_FLAGS_DEBUG "/Zi")
set(CMAKE_CXX_FLAGS_DEBUG "/Zi")

# プロジェクトのビルド
add_executable(my_project main.c)


# CMP0141ポリシーを無効にする
cmake_policy(CMP0141 NEW)

# デバッグ情報フォーマットを "CodeView" に設定
set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "CodeView")

# プロジェクトのビルド
add_executable(my_project main.c)

CMakeポリシー CMP0141 を設定するその他の方法

CMake GUI

1. File メニューから Preferences を選択します。
2. CMake タブを選択します。
3. Policies セクションで CMP0141 を検索します。
4. Value ドロップダウンリストから OLD または NEW を選択します。
5. OK ボタンをクリックして変更を保存します。

CMAKE_MODULE_PATH 変数を使用して、カスタムの CMake モジュールを指定できます。このモジュールは、cmake_policy() コマンドを使用して CMP0141 ポリシーを設定できます。

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "/path/to/custom/modules")

# カスタムモジュールの `SetCMP0141Policy` 関数を呼び出す
include(SetCMP0141Policy)

# プロジェクトのビルド
add_executable(my_project main.c)

環境変数

CMAKE_POLICY_CMP0141 環境変数を使用して、CMP0141 ポリシーを設定できます。

set(CMAKE_POLICY_CMP0141 "OLD")

# プロジェクトのビルド
cmake .

注意: 上記の方法はいずれも、CMake 3.24 以降でのみ使用できます。