{"id":12541,"date":"2017-10-01T00:04:43","date_gmt":"2017-09-30T23:04:43","guid":{"rendered":"https:\/\/sysprogs.com\/w\/?p=12541"},"modified":"2017-10-01T00:04:43","modified_gmt":"2017-09-30T23:04:43","slug":"explaining-project-format-changes-in-visualgdb-5-3","status":"publish","type":"post","link":"https:\/\/sysprogs.com\/w\/explaining-project-format-changes-in-visualgdb-5-3\/","title":{"rendered":"Explaining project format changes in VisualGDB 5.3"},"content":{"rendered":"

The latest VisualGDB 5.3 release introduces a few\u00a0improvements in the project format that avoid hardcoding of the paths and settings in the project files and make toolchain management on different machines easier. However\u00a0some of those changes are not backward compatible with VisualGDB 5.2 and earlier, making it harder to update to v5.3\u00a0if some of\u00a0the\u00a0developers in your organization are still using v5.2. In this post I will\u00a0show you the project file format differences between\u00a0VisualGDB 5.3 and 5.2 and will\u00a0provide examples on making\u00a0v5.3 projects compatible with the older VisualGDB versions.<\/p>\n

<\/p>\n

Non-Embedded Projects<\/h2>\n

The only change for non-embedded projects is the transition from\u00a0storing the detailed toolchain\u00a0information in .vgdbsettings<\/strong> files to only storing the toolchain ID and version and\u00a0loading the details from a\u00a0directory under %LOCALAPPDATA%. Below is the comparison of a\u00a0.vgdbsettings file for a simple project targeting Raspberry Pi\u00a0 created with VisualGDB 5.2 and 5.3 respectively:<\/p>\n\n\n\n\n
VisualGDB 5.2<\/td>\nVisualGDB 5.3<\/td>\n<\/tr>\n
\n
 <Build xsi:type=\"com.visualgdb.build.msbuild\">\r\n\u00a0\u00a0<Toolchain>\r\n \u00a0\u00a0\u00a0\u00a0<Name>Raspberry PI<\/Name>\r\n \u00a0\u00a0\u00a0\u00a0<UniqueID>com.visualgdb.raspberry_pi<\/UniqueID>\r\n \u00a0\u00a0\u00a0\u00a0<Location>C:\\SysGCC\\raspberry<\/Location>\r\n \u00a0\u00a0\u00a0\u00a0<UnixSystem>false<\/UnixSystem>\r\n \u00a0\u00a0\u00a0\u00a0<GCC>C:\\SysGCC\\raspberry\\bin\\arm-linux-gnueabihf-gcc.exe<\/GCC>\r\n \u00a0\u00a0\u00a0\u00a0<GXX>C:\\SysGCC\\raspberry\\bin\\arm-linux-gnueabihf-g++.exe<\/GXX>\r\n \u00a0\u00a0\u00a0\u00a0<GDB>C:\\SysGCC\\raspberry\\bin\\arm-linux-gnueabihf-gdb.exe<\/GDB>\r\n\u00a0\u00a0\u00a0\u00a0<Make>C:\\SysGCC\\raspberry\\bin\\make.exe<\/Make>\r\n \u00a0\u00a0\u00a0\u00a0<AdditionalPathDirectories>\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<string>C:\\SysGCC\\raspberry\\bin<\/string>\r\n \u00a0\u00a0\u00a0\u00a0<\/AdditionalPathDirectories>\r\n \u00a0\u00a0<RequireCmdExe>true<\/RequireCmdExe>\r\n \u00a0\u00a0<RequireCtrlBreak>false<\/RequireCtrlBreak>\r\n \u00a0\u00a0<SourceDirMapping>\r\n \u00a0\u00a0<Directories \/>\r\n \u00a0\u00a0\u00a0\u00a0<PathStyle>MinGWUnixSlash<\/PathStyle>\r\n \u00a0\u00a0<\/SourceDirMapping>\r\n \u00a0\u00a0<\/Toolchain>\r\n\u00a0 <RemoteBuildEnvironment>\r\n \u00a0\u00a0<Records>\r\n \u00a0\u00a0\u00a0\u00a0<Record>\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<VariableName>LANG<\/VariableName>\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<Value>en_US.UTF-8<\/Value>\r\n \u00a0\u00a0\u00a0\u00a0<\/Record>\r\n \u00a0\u00a0\u00a0\u00a0<Record>\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<VariableName>PATH<\/VariableName>\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<Value>C:\\SysGCC\\raspberry\\bin;%PATH%<\/Value>\r\n \u00a0\u00a0\u00a0\u00a0<\/Record>\r\n \u00a0\u00a0<\/Records>\r\n \u00a0\u00a0<\/RemoteBuildEnvironment>\r\n \u00a0\u00a0<ParallelJobCount>0<\/ParallelJobCount>\r\n <\/Build><\/pre>\n<\/td>\n
\n
 <Build xsi:type=\"com.visualgdb.build.msbuild\">\r\n\u00a0 <ToolchainID>\r\n \u00a0\u00a0\u00a0\u00a0<ID>com.visualgdb.raspberry_pi<\/ID>\r\n \u00a0\u00a0\u00a0\u00a0<Version>\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<GCC>4.9.2<\/GCC>\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<GDB>7.7.1<\/GDB>\r\n \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<Revision>4<\/Revision>\r\n \u00a0\u00a0\u00a0\u00a0<\/Version>\r\n \u00a0\u00a0<\/ToolchainID>\r\n \u00a0\u00a0<ParallelJobCount>0<\/ParallelJobCount>\r\n \u00a0\u00a0<SuppressDirectoryChangeMessages>true<\/SuppressDirectoryChangeMessages>\r\n <\/Build><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Note how the\u00a0Toolchain<\/strong> and RemoteBuildEnvironment<\/strong> elements were replaced by a\u00a0shorter ToolchainID<\/strong> element.\u00a0VisualGDB 5.3 will automatically\u00a0locate the toolchain corresponding to the ID and version from the project file and will\u00a0automatically set the\u00a0paths and environment variables from it.<\/p>\n
The .vxcproj file will also\u00a0now store the toolchain ID instead of the toolchain path:<\/p>\n\n\n\n\n
VisualGDB 5.2<\/td>\nVisualGDB 5.3<\/td>\n<\/tr>\n
\n
 <PropertyGroup Condition=\"'$(Configuration)|$(Platform)'=='Debug|VisualGDB'\">\r\n   <GNUConfigurationType>Debug<\/GNUConfigurationType>\r\n   <Toolchain>C:\\SysGCC\\raspberry<\/Toolchain>\r\n <\/PropertyGroup><\/pre>\n<\/td>\n
\n
<PropertyGroup Condition=\"'$(Configuration)|$(Platform)'=='Debug|VisualGDB'\">\r\n   <GNUConfigurationType>Debug<\/GNUConfigurationType>\r\n   <ToolchainID>com.visualgdb.raspberry_pi<\/ToolchainID>\r\n   <ToolchainVersion>4.9.2\/7.7.1\/r4<\/ToolchainVersion>\r\n <\/PropertyGroup><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
For non-MSBuild projects,\u00a0VisualGDB 5.3 also ensures that\u00a0settings like ‘build command’ do not hardcode the toolchain path:<\/p>\n\n\n\n\n
VisualGDB 5.2<\/td>\nVisualGDB 5.3<\/td>\n<\/tr>\n
\n
 <Build xsi:type=\"com.visualgdb.build.make\">\r\n   <MakeFilePathRelativeToSourceDir>Makefile<\/MakeFilePathRelativeToSourceDir>\r\n   <MakeConfigurationName>Debug<\/MakeConfigurationName>\r\n   <Toolchain>\r\n     <!-- ... -->\r\n   <\/Toolchain>\r\n   <MakeCommandTemplate>\r\n   <SkipWhenRunningCommandList>false<\/SkipWhenRunningCommandList>\r\n   <RemoteHost>\r\n     <HostName>BuildMachine<\/HostName>\r\n     <Transport>BuiltinShortcut<\/Transport>\r\n   <\/RemoteHost>\r\n   <Command>cmd.exe<\/Command>\r\n   <Arguments>\/c \"C:\\SysGCC\\raspberry\\bin\\make.exe\"<\/Arguments>\r\n   <WorkingDirectory>$(BuildDir)<\/WorkingDirectory>\r\n   <Environment>\r\n     <Records>\r\n       <Record>\r\n         <VariableName>LANG<\/VariableName>\r\n         <Value>en_US.UTF-8<\/Value>\r\n       <\/Record>\r\n       <Record>\r\n         <VariableName>PATH<\/VariableName>\r\n         <Value>C:\\SysGCC\\raspberry\\bin;%PATH%<\/Value>\r\n       <\/Record>\r\n     <\/Records>\r\n   <\/Environment>\r\n   <BackgroundMode xsi:nil=\"true\" \/>\r\n   <\/MakeCommandTemplate>\r\n <\/Build><\/pre>\n<\/td>\n
\n
 <Build xsi:type=\"com.visualgdb.build.make\">\r\n   <ToolchainID>\r\n     <!-- ... -->\r\n   <\/ToolchainID>\r\n   <MakeFilePathRelativeToSourceDir>Makefile<\/MakeFilePathRelativeToSourceDir>\r\n   <MakeConfigurationName>Debug<\/MakeConfigurationName>\r\n   <MakeCommandTemplate>\r\n   <SkipWhenRunningCommandList>false<\/SkipWhenRunningCommandList>\r\n   <RemoteHost>\r\n     <HostName>BuildMachine<\/HostName>\r\n     <Transport>BuiltinShortcut<\/Transport>\r\n   <\/RemoteHost>\r\n   <Command>$(ToolchainMake)<\/Command>\r\n   <Arguments>$(ToolchainMakeArgs)<\/Arguments>\r\n   <WorkingDirectory>$(BuildDir)<\/WorkingDirectory>\r\n   <BackgroundMode xsi:nil=\"true\" \/>\r\n   <\/MakeCommandTemplate>\r\n <\/Build><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Note the new $(ToolchainMake) and $(ToolchainMakeArgs) variables that are automatically set by VisualGDB when it locates a toolchain matching the ID.<\/p>\n
When you open a VisualGDB 5.2\u00a0project in VisualGDB 5.3, it will suggest automatically upgrading it:\"upgrade\"<\/a><\/p>\n
The upgrade process will\u00a0locate a toolchain in the local toolchain list that matches the explicit definition inside the <Toolchain><\/strong> element and will insert a\u00a0<ToolchainID><\/strong> element referencing it. If no such toolchain is found, VisualGDB will suggest importing it:\"toolchain\"<\/a><\/p>\n
Converted projects will have both the old <Toolchain>\u00a0and the new <ToolchainID> elements.<\/p>\n
You will be able to continue building the\u00a0converted non-embedded projects with both VisualGDB 5.2 and VisualGDB 5.3. However changing the toolchain settings\u00a0via v5.2 GUI will remove the <ToolchainID><\/strong> element\u00a0and change the <Toolchain><\/strong> instead. Changing\u00a0 the toolchain\u00a0via v5.3 GUI will change <ToolchainID><\/strong>, but will keep <Toolchain><\/strong> unchanged.<\/p>\n
If you want to build a project created with v5.3 using VisualGDB 5.2, simply add a <Toolchain><\/strong> element to the .vgdbsettings file manually so that VisualGDB 5.2 can recognize it. If this is an MSBuild-based projects, also ensure you have the <Toolchain><\/strong> property set\u00a0in the .vcxproj file.<\/p>\n
Embedded projects<\/h2>\n
VisualGDB improves the\u00a0usability of embedded projects by using variables like $(BSP_ROOT) throughout the .vcxproj files instead of hardcoding any paths:<\/p>\n\n\n\n\n
VisualGDB 5.2<\/td>\nVisualGDB 5.3<\/td>\n<\/tr>\n
\n
<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<Project DefaultTargets=\"Build\" ToolsVersion=\"14.0\" \r\n  xmlns=\"http:\/\/schemas.microsoft.com\/developer\/msbuild\/2003\">\r\n <!-- ... -->\r\n   <PropertyGroup Condition=\"'$(Configuration)|$(Platform)'=='Debug|VisualGDB'\">\r\n     <Toolchain>C:\\SysGCC\\arm-eabi<\/Toolchain>\r\n   <\/PropertyGroup>\r\n   <ItemGroup>\r\n     <ClCompile Include=\"..\\..\\..\\Users\\<...>\\EmbeddedBSPs\\<...>\\drivers\\AnalogIn.cpp\" \/>\r\n   <!-- ... -->\r\n   <\/ItemGroup>\r\n <!-- ... -->\r\n<\/Project><\/pre>\n<\/td>\n
\n
<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<Project DefaultTargets=\"Build\" ToolsVersion=\"15.0\"\r\n xmlns=\"http:\/\/schemas.microsoft.com\/developer\/msbuild\/2003\">\r\n <!-- ... -->\r\n <PropertyGroup Label=\"Globals\">\r\n   <VCProjectVersion>15.0<\/VCProjectVersion>\r\n   <ProjectGuid>...<\/ProjectGuid>\r\n   <BSP_ID>com.sysprogs.arm.stm32<\/BSP_ID>\r\n   <BSP_VERSION>4.3<\/BSP_VERSION>\r\n   <InPlaceBSPSubdir \/>\r\n <\/PropertyGroup>\r\n <PropertyGroup Condition=\"...\">\r\n   <GNUConfigurationType>Debug<\/GNUConfigurationType>\r\n   <ToolchainID>com.visualgdb.arm-eabi<\/ToolchainID>\r\n   <ToolchainVersion>6.2.0\/7.12\/r4<\/ToolchainVersion>\r\n <\/PropertyGroup>\r\n <!-- ... -->\r\n <ItemGroup>\r\n   <ClCompile Include=\"$(BSP_ROOT)\\drivers\\AnalogIn.cpp\" \/>\r\n <!-- ... -->\r\n <\/ItemGroup>\r\n<\/Project><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
This allows opening the project on\u00a0different machines with different locations of the BSP and lets VisualGDB find the files without\u00a0hardcoding anything. On non-MSBuild projects VisualGDB explicitly inserts a reference to the file that defines those variables:<\/p>\n
 <ImportGroup Label=\"VisualGDBFindComponents\">\r\n   <Import Project=\"$(LOCALAPPDATA)\\VisualGDB\\FindComponents.props\" \/>\r\n <\/ImportGroup><\/pre>\n
VisualGDB 5.3 automatically maintains the FindComponents.props<\/strong> file to reflect the locations of all installed toolchains and BSPs. If you want to build VisualGDB 5.3 projects on VisualGDB 5.2, simply create the FindComponents.props file manually and define the\u00a0variables like BSP_ROOT conditionally:<\/p>\n
<Project ToolsVersion=\"4.0\" xmlns=\"http:\/\/schemas.microsoft.com\/developer\/msbuild\/2003\">\r\n <PropertyGroup Condition=\"'$(BSP_ID)' != ''\">\r\n <BSP_ROOT Condition=\"('$(BSP_ID)' == 'com.sysprogs.arm.stm32') and (('$(BSP_VERSION)' == '4.3') or ('$(BSP_VERSION)' == ''))\">C:\/Users\/virtual.SYSPROGS\/AppData\/Local\/VisualGDB\/EmbeddedBSPs\/arm-eabi\/com.sysprogs.arm.stm32<\/BSP_ROOT>\r\n <\/PropertyGroup>\r\n<\/Project><\/pre>\n
Ensure you import if from your .vcxproj file, as pre-v5.3 VisualGDB won’t to this automatically.<\/p>\n
Automatic\u00a0updating<\/h2>\n
You can\u00a0prevent VisualGDB 5.3 from automatically upgrading v5.2 projects by disabling the following setting under Tools->Options:\"pkg\"<\/a><\/p>\n
To disable\u00a0automatic toolchain definition upgrading use the setting shown below:\"oldtc\"<\/a><\/p>\n
If you haven’t tried VisualGDB 5.3 yet, give it a try. It includes numerous improvements to building and debugging experience, supports profiling and code coverage for Linux projects and many more features. You can find the detailed changelog here:\u00a0https:\/\/visualgdb.com\/history\/.<\/p>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
The latest VisualGDB 5.3 release introduces a few\u00a0improvements in the project format that avoid hardcoding of the paths and settings in the project files and make toolchain management on different machines easier. However\u00a0some of those changes are not backward compatible with VisualGDB 5.2 and earlier, making it harder to update to v5.3\u00a0if some of\u00a0the\u00a0developers in … Continue reading Explaining project format changes in VisualGDB 5.3<\/span> →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"categories":[1],"tags":[422],"_links":{"self":[{"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/posts\/12541"}],"collection":[{"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/comments?post=12541"}],"version-history":[{"count":2,"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/posts\/12541\/revisions"}],"predecessor-version":[{"id":12547,"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/posts\/12541\/revisions\/12547"}],"wp:attachment":[{"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/media?parent=12541"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/categories?post=12541"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sysprogs.com\/w\/wp-json\/wp\/v2\/tags?post=12541"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}