Source control with CCS
This document is now maintained here
Files to check in
One of the first questions that come up when working with source control and CCS is which CCS project files need to be checked in to source control.
CCSv5 and greater
The following project files should be checked into source control:
- .settings folder
- makefile.defs (if using SYS/BIOS)
.ccsproject has project information specific to CCS.
.cproject and .project are Eclipse CDT project files.
.settings folder is a standard Eclipse folder that has settings that apply for the project.
makefiles.defs has additional make rules included by the generated project makefile for SYS/BIOS projects.
The following files and folders should not be checked into source control:
- \Debug or \Release \<configuration name> folder
- \.config folder
- \.launches folder
Configuration folders like \Debug or \Release are generated folders that contain build artifacts like object files and do not need to be checked into source control.
.xdchelp is a generated file that is used to help display error messages in the problems view and does not need to be checked into source control.
.config and .launches are generated folders that do not need to be checked into source control.
For target configuration files or targetConfigs folder: If the project is configured to "Manage the project's target-configuration automatically" and the default settings in the generated ccxml file are not changed, then it is optional to check it into source control (as it will get auto-regenerated if missing). But if the ccxml file is being managed manually, or modifications were made to the default settings in the auto-generated one, then it is advisable to check it into source control.
See this FAQ.
Source control Integration
CVS and GIT
There is more information on using Git with CCS here: Resource Explorer article on Git
CCSv5 and greater has native support for CVS and GIT so you can browse repositories, check in/out files, get history, etc all from within the GUI.
To use CVS with CCSv6, however, you must first install its support via the CCS App Center. Simply go to menu View --> CCS App Center. From there, type in CVS in the search box, select Install and follow the instructions. You will have to restart CCS.
You can explore the CVS and GIT repository from CCS menu Window->Open Perspective->Other, enable Show All, and select CVS Repository Exploring or Git Repository Exploring.
More information on working with CVS and Git can be found in the CCS Online Help.
Plug-ins are available from the Eclipse Marketplace for some other source control providers such as ClearCase, SourceSafe, SVN.
When searching for plug-ins, make sure to look for ones that support the same version of Eclipse that your version of CCS is based off of for best compatibility (CCS 5.1 and 5.2 are based off Eclipse 3.7, CCS 5.3+ is based off Eclipse 3.8 and CCSv6.0 is based off Eclipse 4.3).
For Github, the e2e user Glenn Vassallo kindly created step-by-step instructions in this post. These instructions are reproduced below:
Cloning a Github Repository to use CCS:
- Install Github for Windows from here - https://windows.github.com/
- Start CCS and select an existing workspace or create a new workspace
- Go to the Github repository you wish to use and click on Clone in Desktop
- When prompted select Launch Application to allow Github for Windows start
- In the browse dialog box, located the Workspace you selected in step 2 and press ok
- Wait for the Cloning process to complete
- Go to CCS and select Project menu and Import CCS Project option
- Press the Browse button for Select search-directory
- Then browse to the Workspace and press ok
- Make sure you tick the project you just cloned
- Do not check either “Automatically import referenced projects found in same directory” or “Copy projects into workspace”
- Press the Finish button
- You should now have a working Git repository in your workspace
Using Git and GitHub in CCS
- Right click on the project and select Team
- The Commit to Commit
- Pull to get the latest from the Github Repository
- Remote - Push to publish latest update to Github Repository
You can install Eclipse plug-ins by one of these methods:
- Use the Eclipse Update Manager
- CCS menu Help -> Install New Software, then specify remote site (URL) or local site (directory)
- Use the Eclipse Marketplace
- CCS menu Help -> Eclipse Marketplace
- Drop-in into CCS installation
- Many plug-ins can simply be downloaded as an archive and copied into the .\ccsv5\eclipse\dropins folder
The CCS Plugins category has more information on installing some plugins that are known to work with CCS.