Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Getting started with CDT development"
m |
|||
| (47 intermediate revisions by 10 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | == Eclipse SDK == | |
| − | + | The very first thing you'll need to do to work on the CDT sources is install an Eclipse SDK (officially known as the ''Eclipse Project''). The SDK contains the Eclipse platform plus other features that developers typically need to develop plug-ins, e.g., JDT and PDE. Which version of the SDK you need depends on which version of CDT you're building. To build the master branch of CDT today (September 26, 2014), you need Eclipse 4.4 or above. To build an earlier version of CDT, you might need to use an earlier version of Eclipse SDK. Visit the [http://www.eclipse.org/cdt/downloads.php CDT downloads page] to see which version of Eclipse/SDK matches a particular CDT version. | |
| − | + | ==== Eclipse Setup ==== | |
| + | * Get the latest Eclipse Standard package (current 4.4.1) from http://www.eclipse.org/downloads. You can also find older versions of the Eclipse SDK here: http://archive.eclipse.org/eclipse/downloads/ | ||
| + | * Install a separate copy of CDT 8.5 (for master branch) to establish an API baseline in the Preferences. See [[CDT/policy#Using_API_Tooling]] | ||
| + | * Install API Tools Execution Environment Descriptions. You can get it from Help->Install New Software... | ||
| − | + | == Setting up the Sources<br> == | |
| − | + | For detailed information on how to setup git, and check out source of CDT as a committer, see [[CDT/git]]. | |
| + | Otherwise, follow the non-committer setup instructions below. | ||
| − | + | ==== Clone the Repo ==== | |
| + | From the Git perspective, select Clone a Git Repository action | ||
| + | * Cut & Paste following url in the first page of wizard for cloning: git://git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git | ||
| + | * It will ask you what branches to import. If you only care about head select master, if you want to work with other branches select a corresponding branch, for example cdt_8_4. | ||
| + | * Press Next. As location where files are stored select a folder inside your workspaces, for example workspace/cdt-git | ||
| + | * Press Finish (skip Gerrit page) | ||
| + | * This should take about 3-5 minutes | ||
| + | From the repo, select Import Projects... | ||
| + | * Select all the projects or individual. Project filter does not seems to work. It maybe easier select all, then close projects you don't need | ||
| − | + | Here's a list of projects you could start with: | |
| − | + | * org.eclipse.cdt.codan.checkers | |
| + | * org.eclipse.cdt.codan.checkers.ui | ||
| + | * org.eclipse.cdt.codan.core | ||
| + | * org.eclipse.cdt.codan.core.cxx | ||
| + | * org.eclipse.cdt.codan.ui | ||
| + | * org.eclipse.cdt.codan.ui.cfgview | ||
| + | * org.eclipse.cdt.codan.ui.cxx | ||
| + | * org.eclipse.cdt.core | ||
| + | * org.eclipse.cdt.core.native | ||
| + | * org.eclipse.cdt.core.linux (Platform specific, change accordingly) | ||
| + | * org.eclipse.cdt.core.linux.x86_64 (Platform specific, change accordingly) | ||
| + | * org.eclipse.cdt.core.win32 (Platform specific, change accordingly) | ||
| + | * org.eclipse.cdt.core.win32.x86 (Platform specific, change accordingly) | ||
| + | * org.eclipse.cdt.core.win32.x86_64 (Platform specific, change accordingly) | ||
| + | * org.eclipse.cdt.debug.core | ||
| + | * org.eclipse.cdt.debug.mi.core | ||
| + | * org.eclipse.cdt.debug.mi.ui | ||
| + | * org.eclipse.cdt.debug.ui | ||
| + | * org.eclipse.cdt.dsf | ||
| + | * org.eclipse.cdt.dsf.gdb | ||
| + | * org.eclipse.cdt.dsf.gdb.ui | ||
| + | * org.eclipse.cdt.dsf.ui | ||
| + | * org.eclipse.cdt.gdb | ||
| + | * org.eclipse.cdt.gdb.ui | ||
| + | * org.eclipse.cdt.launch | ||
| + | * org.eclipse.cdt.make.core | ||
| + | * org.eclipse.cdt.make.ui | ||
| + | * org.eclipse.cdt.managedbuilder.core | ||
| + | * org.eclipse.cdt.managedbuilder.gnu.ui | ||
| + | * org.eclipse.cdt.managedbuilder.ui | ||
| + | * org.eclipse.cdt.ui | ||
| − | + | If you want to run tests, add the corresponding test project, for example, org.eclipse.cdt.core.tests. | |
| − | == | + | ==== Dependencies ==== |
| + | The easiest way to satisfy all dependencies for CDT is to set a target platform. The target platform will download all the dependencies so that you can compile and run your imported CDT plug-ins without having to install the dependencies in your Eclipse installation. | ||
| − | + | To set the target platform: | |
| + | * Expand the "org.eclipse.cdt.target" project. | ||
| + | * Double-click on cdt-e4.4.target (or the .target file that corresponds to the Eclipse version you want to target). | ||
| + | * In the editor that just opened, click ''Set as Target Platform'' on the top right. | ||
| − | + | Eclipse will now download the required dependencies, which may take some time the first time. Once this is done, it should trigger a full build of your workspace and a lot of errors should go away. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | If you wish to switch target platforms in the future, you can open a different .target file, or you can go to "Window -> Preferences -> Plug-in Development -> Target Platform". | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
== Launching == | == Launching == | ||
| Line 36: | Line 74: | ||
After all the CDT projects have successfully built, you'll probably want to run and/or do source-level debugging of the CDT code. Open the PDE (Plug-in Development Environment) perspective: Window->Perspective->Other->"Plug in Development". There, you'll see a project with the name org.eclipse.cdt.ui, right click the org.eclipse.cdt.ui project, select "Run As"->"eclipse application". You should see a new instance of eclipse - with the latest version of eclipse CDT plugins. | After all the CDT projects have successfully built, you'll probably want to run and/or do source-level debugging of the CDT code. Open the PDE (Plug-in Development Environment) perspective: Window->Perspective->Other->"Plug in Development". There, you'll see a project with the name org.eclipse.cdt.ui, right click the org.eclipse.cdt.ui project, select "Run As"->"eclipse application". You should see a new instance of eclipse - with the latest version of eclipse CDT plugins. | ||
| − | Alternatively, you can create a Launcher: Go to Run - Debug Configurations... Select "Eclipse Application" and click New. Give the Debug Configuration a Name and the other defaults are OK. This appears to be a more widely used launching technique. | + | Alternatively, you can create a Launcher: Go to Run - Debug Configurations... Select "Eclipse Application" and click New. Give the Debug Configuration a Name and the other defaults are OK. This appears to be a more widely used launching technique. |
| − | + | Until you are familiar with the CDT code base, using a Debug Launcher and experimenting with breakpoints is probably the best way to get a warm fuzzy feeling if you have doubts about modifications you are making.<br> | |
| − | == Submitting and Applying Patches == | + | == Submitting and Applying Patches == |
| + | If you wish to contribute your changes to CDT see these [[CDT/contributing|instructions]]. | ||
| − | + | == Creating a runtime patch == | |
| − | + | If you want just patch up your local installation you can export plugin(s) to which source patch is applied using Export->Plugins, export as archive and use your eclipse installation as destination. Make sure after this you have 2 version of the same plugin (one from installation and one new) in the plugins directory and version qualifier of your new plugin is higher. | |
| − | + | == Building the CDT p2 repository == | |
| − | + | You can generate your own CDT zip using Maven. | |
| − | + | * Install Maven if not already installed (mvn command). Maven 3.0.5 or greater is required. | |
| + | * In command line, change the directory to the cdt git directory (the top folder that contains a pom.xml file) | ||
| + | * Run "mvn package". This will take a lot longer the first time because it needs to download a lot of things. If it seems stuck on a download and you're behind a proxy, make sure that you set your [http://maven.apache.org/settings.html#Proxies Maven proxy settings]. | ||
| + | * If the build is succesfull, the zip will be in org.eclipse.cdt/releng/org.eclipse.cdt.repo/target/org.eclipse.cdt.repo.zip | ||
| + | * Go to Install new software, click Add, Archive and browse for to the zip | ||
| + | You should now be able to install or update CDT using your modified code. | ||
| − | + | [[Category:CDT]] | |
Revision as of 10:25, 26 September 2014
Contents
Eclipse SDK
The very first thing you'll need to do to work on the CDT sources is install an Eclipse SDK (officially known as the Eclipse Project). The SDK contains the Eclipse platform plus other features that developers typically need to develop plug-ins, e.g., JDT and PDE. Which version of the SDK you need depends on which version of CDT you're building. To build the master branch of CDT today (September 26, 2014), you need Eclipse 4.4 or above. To build an earlier version of CDT, you might need to use an earlier version of Eclipse SDK. Visit the CDT downloads page to see which version of Eclipse/SDK matches a particular CDT version.
Eclipse Setup
- Get the latest Eclipse Standard package (current 4.4.1) from http://www.eclipse.org/downloads. You can also find older versions of the Eclipse SDK here: http://archive.eclipse.org/eclipse/downloads/
- Install a separate copy of CDT 8.5 (for master branch) to establish an API baseline in the Preferences. See CDT/policy#Using_API_Tooling
- Install API Tools Execution Environment Descriptions. You can get it from Help->Install New Software...
Setting up the Sources
For detailed information on how to setup git, and check out source of CDT as a committer, see CDT/git. Otherwise, follow the non-committer setup instructions below.
Clone the Repo
From the Git perspective, select Clone a Git Repository action
- Cut & Paste following url in the first page of wizard for cloning: git://git.eclipse.org/gitroot/cdt/org.eclipse.cdt.git
- It will ask you what branches to import. If you only care about head select master, if you want to work with other branches select a corresponding branch, for example cdt_8_4.
- Press Next. As location where files are stored select a folder inside your workspaces, for example workspace/cdt-git
- Press Finish (skip Gerrit page)
- This should take about 3-5 minutes
From the repo, select Import Projects...
- Select all the projects or individual. Project filter does not seems to work. It maybe easier select all, then close projects you don't need
Here's a list of projects you could start with:
- org.eclipse.cdt.codan.checkers
- org.eclipse.cdt.codan.checkers.ui
- org.eclipse.cdt.codan.core
- org.eclipse.cdt.codan.core.cxx
- org.eclipse.cdt.codan.ui
- org.eclipse.cdt.codan.ui.cfgview
- org.eclipse.cdt.codan.ui.cxx
- org.eclipse.cdt.core
- org.eclipse.cdt.core.native
- org.eclipse.cdt.core.linux (Platform specific, change accordingly)
- org.eclipse.cdt.core.linux.x86_64 (Platform specific, change accordingly)
- org.eclipse.cdt.core.win32 (Platform specific, change accordingly)
- org.eclipse.cdt.core.win32.x86 (Platform specific, change accordingly)
- org.eclipse.cdt.core.win32.x86_64 (Platform specific, change accordingly)
- org.eclipse.cdt.debug.core
- org.eclipse.cdt.debug.mi.core
- org.eclipse.cdt.debug.mi.ui
- org.eclipse.cdt.debug.ui
- org.eclipse.cdt.dsf
- org.eclipse.cdt.dsf.gdb
- org.eclipse.cdt.dsf.gdb.ui
- org.eclipse.cdt.dsf.ui
- org.eclipse.cdt.gdb
- org.eclipse.cdt.gdb.ui
- org.eclipse.cdt.launch
- org.eclipse.cdt.make.core
- org.eclipse.cdt.make.ui
- org.eclipse.cdt.managedbuilder.core
- org.eclipse.cdt.managedbuilder.gnu.ui
- org.eclipse.cdt.managedbuilder.ui
- org.eclipse.cdt.ui
If you want to run tests, add the corresponding test project, for example, org.eclipse.cdt.core.tests.
Dependencies
The easiest way to satisfy all dependencies for CDT is to set a target platform. The target platform will download all the dependencies so that you can compile and run your imported CDT plug-ins without having to install the dependencies in your Eclipse installation.
To set the target platform:
- Expand the "org.eclipse.cdt.target" project.
- Double-click on cdt-e4.4.target (or the .target file that corresponds to the Eclipse version you want to target).
- In the editor that just opened, click Set as Target Platform on the top right.
Eclipse will now download the required dependencies, which may take some time the first time. Once this is done, it should trigger a full build of your workspace and a lot of errors should go away.
If you wish to switch target platforms in the future, you can open a different .target file, or you can go to "Window -> Preferences -> Plug-in Development -> Target Platform".
Launching
After all the CDT projects have successfully built, you'll probably want to run and/or do source-level debugging of the CDT code. Open the PDE (Plug-in Development Environment) perspective: Window->Perspective->Other->"Plug in Development". There, you'll see a project with the name org.eclipse.cdt.ui, right click the org.eclipse.cdt.ui project, select "Run As"->"eclipse application". You should see a new instance of eclipse - with the latest version of eclipse CDT plugins.
Alternatively, you can create a Launcher: Go to Run - Debug Configurations... Select "Eclipse Application" and click New. Give the Debug Configuration a Name and the other defaults are OK. This appears to be a more widely used launching technique.
Until you are familiar with the CDT code base, using a Debug Launcher and experimenting with breakpoints is probably the best way to get a warm fuzzy feeling if you have doubts about modifications you are making.
Submitting and Applying Patches
If you wish to contribute your changes to CDT see these instructions.
Creating a runtime patch
If you want just patch up your local installation you can export plugin(s) to which source patch is applied using Export->Plugins, export as archive and use your eclipse installation as destination. Make sure after this you have 2 version of the same plugin (one from installation and one new) in the plugins directory and version qualifier of your new plugin is higher.
Building the CDT p2 repository
You can generate your own CDT zip using Maven.
- Install Maven if not already installed (mvn command). Maven 3.0.5 or greater is required.
- In command line, change the directory to the cdt git directory (the top folder that contains a pom.xml file)
- Run "mvn package". This will take a lot longer the first time because it needs to download a lot of things. If it seems stuck on a download and you're behind a proxy, make sure that you set your Maven proxy settings.
- If the build is succesfull, the zip will be in org.eclipse.cdt/releng/org.eclipse.cdt.repo/target/org.eclipse.cdt.repo.zip
- Go to Install new software, click Add, Archive and browse for to the zip
You should now be able to install or update CDT using your modified code.