Difference between revisions of "Eclipse CDT4 Generator"

From KitwarePublic
Jump to navigationJump to search
(Replace content with link to new CMake community wiki)
(28 intermediate revisions by 11 users not shown)
Line 1: Line 1:
<!-- [[Image:CMakeEclipseCDT4_TSPBuild.png|thumb|right|350px|CMake generated Eclipse Project for TSP]] -->
[[Image:CMakeEclipseCDT4GeneratorScreendump.png|thumb|right|350px|Eclipse opens CMake project file]]
This page has moved [https://gitlab.kitware.com/cmake/community/wikis/doc/editors/Eclipse-CDT4-Generator here].
Starting with version 2.6.0 CMake includes an Eclipse CDT 4.0 generator (not released yet, but already in cvs). It works together with the Makefile generators available now (i.e. "Unix Makefiles", "MinGW Makefiles", "MSYS Makefiles", and maybe "NMake Makefiles").
With this generator it is possible to create a set of .project/.cproject files that can be imported in Eclipse as an "Existing Eclipse project".
Note that CMake 2.4.x users may follow instructions provided here [[CMake:Eclipse]] in order to setup an Eclipse+CMake usage ''manually''.
==Using Eclipse CDT4 Generator==
Using the Eclipse CDT4 generator is not different as using another CMake generator, it works for in-source and out-of-source builds.
In this example I assume the source tree of my project
is ''/home/eric/certi_src''
<li> Create a build directory, go there and run CMake:
<pre>mkdir /home/eric/certi_build
cd /home/eric/certi_build
cmake -G"Eclipse CDT4 - Unix </pre>
After that you will find two Eclipse file in your build tree:
    <li> <tt>certi_build/.project</tt></li>
    <li> <tt>certi_build/.cproject</tt></li>
<li> Import the created project file into Eclipse:
    <li> Launch eclipse</li>
    <li> Import project using Menu ''File->Import''
          [[Image:Capture-EclipseMenuFileImport.jpg|thumb|center|200px|Eclipse Menu->File->Import]]</li>
    <li> Select ''General->Existing projects into workspace'':
          [[Image:Capture-EclipseProjectsIntoWorkspace.jpg|thumb|center|200px|Existing Projects into Workspace]]</li>
    <li> Browse where your build tree is and select the root build tree directory. Keep "Copy projects into workspace" unchecked.
          [[Image:Capture-Import.jpg|thumb|center|200px|Eclipse Import after build tree selection]]</li>
    <li> You get a fully functional eclipse project
          [[Image:Capture-certi_build-Eclipse.jpg|thumb|center|200px|Eclipse Imported CERTI project]]</li>
==Integration with version control systems==
If you are using in-source builds, there are no problems with the Eclipse support for version control systems like cvs or Subversion.
If you are using out-of-source builds, there is a limitation of the CMake CDT4 Eclipse generator when
your source tree is handled by a versioning system (like CVS, Subversion or other). You may read the referred discussions in the links below.
One ''solution'' is to have multiple projects:
# One project for version management. This one may be obtained by a normal ''checkout'' using new project from CVS/Subversion/etc. .
# One or more projects for building, resulting from the imported CMake generated project(s) obtained by the previously described procedure.
You will find a screen cast describing how to it
here: [[Image:CMakeEclipseCDT4andCVS-2.ogg]]
==Discussion about Eclipse CDT4 Generator limitations==
If you would like to monitor the changes to the EclipseCDT4 support, you can view the following links which contain the cvs history log for changes to the two main files:
* [http://www.cmake.org/cgi-bin/viewcvs.cgi/Source/cmExtraEclipseCDT4Generator.h?root=CMake&view=log cmExtraEclipseCDT4Generator.h]
* [http://www.cmake.org/cgi-bin/viewcvs.cgi/Source/cmExtraEclipseCDT4Generator.cxx?root=CMake&view=log cmExtraEclipseCDT4Generator.cxx]
Eclipse assumes project files (i.e. .project and .cproject) ''must
be at the root of the project tree'' '''and''' a project
may be handled by a versioning system (CVS, SVN, ...) iff
''the root project tree is''.
This assumption clashes with the fact that CMake generated files
should ''stay in the build tree'' whereas source files (which are usually those handled
by a versioning system) reside ''in the source tree''.
There has been a fair amount of discussion regarding this problem
of the Eclipse CDT4 Generator:
<li>[http://www.cmake.org/pipermail/cmake/2007-October/016956.html Trouble with CMake + Eclipse + SVN/CVS]
<li>[http://www.cmake.org/pipermail/cmake/2007-August/015504.html *Updated* Eclipse CDT4 CMake Generator - Pre-Alpha version]
<li>[http://dev.eclipse.org/mhonarc/lists/platform-cvs-dev/msg00462.html Partially Shared project using Eclipse CDT (cdt-dev ML)]

Latest revision as of 11:41, 30 April 2018

The CMake community Wiki has moved to the Kitware GitLab Instance.

This page has moved here.