CMakeでVisual Studio ソリューションのソースコード管理を楽にする「VS_SCC_LOCALPATH」

CMake の "Properties: Targets" における "VS_SCC_LOCALPATH" の詳細解説

"VS_SCC_LOCALPATH" は、CMake の "Properties: Targets" で使用されるプロパティです。Visual Studio ソリューション内でソースコード管理 (SCC) を使用する際に、ソースファイルのローカルパスを指定するために使用されます。

設定方法

"VS_SCC_LOCALPATH" は、ターゲットプロパティとして設定できます。以下の例は、"mytarget" というターゲットに対して "VS_SCC_LOCALPATH" を設定する方法を示しています。

target_properties(mytarget PROPERTIES
  VS_SCC_LOCALPATH "${CMAKE_SOURCE_DIR}/src"
)

上記の場合、"mytarget" に関連するソースファイルのローカルパスは "${CMAKE_SOURCE_DIR}/src" となります。

使用例

"VS_SCC_LOCALPATH" は、以下の様な状況で役立ちます。

• ソースファイルが複数のフォルダに分散している場合
• ソースファイルの一部のみを SCC で管理したい場合
• シンボリックリンクを使用している場合

補足

• "VS_SCC_LOCALPATH" は、Visual Studio ソリューションでのみ使用できます。
• "VS_SCC_LOCALPATH" は、SCC プロバイダーによって異なる動作をする場合があります。

注意

この解説は参考情報であり、最新の情報ではない可能性があります。詳細は、上記の参考情報を参照してください。

CMake の "Properties: Targets" における "VS_SCC_LOCALPATH" のサンプルコード

サンプルコード 1: 単一のフォルダ

target_properties(mytarget PROPERTIES
  VS_SCC_LOCALPATH "${CMAKE_SOURCE_DIR}/src"
)

サンプルコード 2: 複数のフォルダ

target_properties(mytarget PROPERTIES
  VS_SCC_LOCALPATH
    "${CMAKE_SOURCE_DIR}/src1"
    "${CMAKE_SOURCE_DIR}/src2"
)

この例では、"mytarget" に関連するソースファイルのローカルパスを "CMAKES​OURCED​IR/src1"と"{CMAKE_SOURCE_DIR}/src2" に設定しています。

サンプルコード 3: シンボリックリンク

target_properties(mytarget PROPERTIES
  VS_SCC_LOCALPATH "${CMAKE_SOURCE_DIR}/src"
)

add_custom_command(
  TARGET mytarget
  POST_BUILD
  COMMAND "git add ${CMAKE_SOURCE_DIR}/src"
)

この例では、"mytarget" に関連するソースファイルのローカルパスを "${CMAKE_SOURCE_DIR}/src" に設定しています。また、ビルド後に "git add" コマンドを実行して、ソースファイルを Git リポジトリに追加しています。

サンプルコード 4: SCC プロバイダー固有の設定

target_properties(mytarget PROPERTIES
  VS_SCC_LOCALPATH "${CMAKE_SOURCE_DIR}/src"
  VS_SCC_PROVIDER "Subversion"
)

この例では、"mytarget" に関連するソースファイルのローカルパスを "${CMAKE_SOURCE_DIR}/src" に設定し、SCC プロバイダーを Subversion に設定しています。

注意

これらのサンプルコードは参考情報であり、最新の情報ではない可能性があります。詳細は、上記の参考情報を参照してください。

"VS_SCC_LOCALPATH" を設定する他の方法

CMake GUI

1. CMake GUI で、ターゲットを選択します。
2. "Properties" パネルで、"Configuration" を "Debug" または "Release" に設定します。
3. "General" タブで、"Source Control" グループを選択します。
4. "Local Path" フィールドに、ソースファイルのローカルパスを入力します。
5. "Apply" をクリックして、変更を保存します。

Visual Studio プロジェクトファイル (.vcxproj) を編集して "VS_SCC_LOCALPATH" を設定することもできます。以下の手順に従ってください。

1. Visual Studio で、プロジェクトを開きます。
2. ソリューションエクスプローラーで、プロジェクトファイルを右クリックして、"編集" を選択します。
3. XML エディターで、次の要素を見つけます。

<PropertyGroup Label="Source Control">
  <SccLocalPath>...</SccLocalPath>
</PropertyGroup>

1. "SccLocalPath" 要素内のパスを、ソースファイルのローカルパスに変更します。
2. ファイルを保存して閉じます。

注意

これらの方法は、CMake を使用してプロジェクトをビルドする場合にのみ使用できます。Visual Studio だけでプロジェクトをビルドする場合は、Visual Studio のプロジェクト設定を使用してソースコード管理を設定する必要があります。