Getting Started/Using an IDE with KDE4 - Revision history

Px79: Added explaination, what "git clone ..." will do (for git-newcomers like me)

2011-11-15T20:19:31Z

Added explaination, what "git clone ..." will do (for git-newcomers like me)

Px79: Changes the source's source from svn to git

2011-11-15T20:13:50Z

Changes the source's source from svn to git

Px79: inserted link to discussion page

2011-11-08T20:38:02Z

inserted link to discussion page

Px79: Updated link to KTimeTracker

2011-11-08T19:54:21Z

Updated link to KTimeTracker

Icwiener: Proofreading

2011-09-28T19:43:07Z

Proofreading

Tstaerk: /* QtCreator */

2011-09-26T07:52:37Z

‎QtCreator

Tstaerk: less hr's

2011-09-25T12:55:46Z

less hr's

Tstaerk: get some hr's

2011-09-25T12:54:24Z

get some hr's

Tstaerk: /* QtCreator */

2011-09-25T10:39:33Z

‎QtCreator

Tstaerk: KDEvelop is outdated. Plus, describing a simple integration takes several pages :(

2011-09-25T10:34:11Z

KDEvelop is outdated. Plus, describing a simple integration takes several pages :(

Show changes

@@ Line 32: / Line 32: @@
 : As said, we use kdepim as example here. So, download ("checkout") kdepim using git (for advanced git-usage see [[Development/Git/Configuration]], especially [[Development/Git/Configuration#URL_Renaming|URL-Renaming]]):
 <syntaxhighlight lang="bash">
 git clone git://anongit.kde.org/kdepim
 </syntaxhighlight>
-: We assume you checked out into /home/user/kdepim.
+: This will check out into /home/user/kdepim. (Our sample setup for this tutorial)
 * Compile kdepim

@@ Line 30: / Line 30: @@
 * Download kdepim
-: As said, we use kdepim as example here. So, download ("checkout") kdepim using Subversion (if <tt>svn co</tt> does not work, see discussion page), e.g. as anonymous:
+: As said, we use kdepim as example here. So, download ("checkout") kdepim using git (for advanced git-usage see [[Development/Git/Configuration]], especially [[Development/Git/Configuration#URL_Renaming|URL-Renaming]]):
 <syntaxhighlight lang="bash">
-svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepim
+git clone git://anongit.kde.org/kdepim
 </syntaxhighlight>
 : We assume you checked out into /home/user/kdepim.

@@ Line 30: / Line 30: @@
 * Download kdepim
-: As said, we use kdepim as example here. So, download ("checkout") kdepim using Subversion, e.g. as anonymous:
+: As said, we use kdepim as example here. So, download ("checkout") kdepim using Subversion (if <tt>svn co</tt> does not work, see discussion page), e.g. as anonymous:
 <syntaxhighlight lang="bash">
 svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepim

@@ Line 4: / Line 4: @@
      |[[image:Snapshot-eclipse.png|right|thumb|200px|KDE4's ktimetracker loaded as eclipse project]]
      |}
-This describes how to use Eclipse to develop KDE 4 applications. It has been tested with Eclipse Ganymede and SUSE Linux 11.1 but should work same or similar with every combination. As an example KDE application we use [http://userbase.kde.org/ktimetracker ktimetracker] from the kdepim module, other applications should work likewise.
+This describes how to use Eclipse to develop KDE 4 applications. It has been tested with Eclipse Ganymede and SUSE Linux 11.1 but should work same or similar with every combination. As an example KDE application we use [http://userbase.kde.org/KTimeTracker KTimeTracker] from the kdepim module, other applications should work likewise.
 Using this description you will be able to
@@ Line 98: / Line 98: @@
 * http://javathreads.de/2008/07/subversion-unter-eclipse-ganymede-konfigurieren/
 * http://nienhueser.de/blog/?p=19
 == QtCreator ==

@@ Line 4: / Line 4: @@
      |[[image:Snapshot-eclipse.png|right|thumb|200px|KDE4's ktimetracker loaded as eclipse project]]
      |}
-This describes how to use Eclipse to develop KDE 4 applications. It has been tested with Eclipse Ganymed and SUSE Linux 11.1 but should work same or similar with every combination. As an example KDE application we use [http://userbase.kde.org/ktimetracker ktimetracker] from the kdepim module, other applications short work analog.
+This describes how to use Eclipse to develop KDE 4 applications. It has been tested with Eclipse Ganymede and SUSE Linux 11.1 but should work same or similar with every combination. As an example KDE application we use [http://userbase.kde.org/ktimetracker ktimetracker] from the kdepim module, other applications should work likewise.
 Using this description you will be able to
-* update your working copy of KDE source code using the command svn
+* update your working copy of KDE source code using the ''svn'' command
-* build your KDE module using cmake
+* build your KDE module using CMake
-* build your KDE application from within eclipse using make
+* build your KDE application from within Eclipse using Make
-* compile and run your application with one click from eclipse
+* compile and run your application with one click from Eclipse
 * get auto-completion when editing KDE source code
-* have an overview and navigation about your classes within eclipse
+* have an overview and navigation about your classes within Eclipse
 * have call trees for your functions
@@ Line 18: / Line 18: @@
 * Check your requirements
-: Trying with a virtual machine [[User:Tstaerk|I]] had problems starting Eclipse with less than 1 GB RAM. After assigning 3 GB RAM to my virtual machine, Eclipse finally started.
+: Trying with a virtual machine [[User:Tstaerk|I]] had problems starting Eclipse with less than 1 GB RAM. After assigning 3 GB RAM to the virtual machine, Eclipse finally started.
-* Install eclipse
+* Install Eclipse
-: Download Eclipse IDE for C/C++ developers from http://www.eclipse.org. We unpack it to /home/user/eclipse.
+: Download Eclipse IDE for C/C++ developers from http://www.eclipse.org. Unpack it to /home/user/eclipse.
 * Install the CDT
-: Download the Eclipse IDE for C/C++ Developers (68 MB) from http://www.eclipse.org/cdt/ and unpack it into your eclipse folder, in our case /home/user/eclipse.
+: Download the Eclipse IDE for C/C++ Developers (68 MB) from http://www.eclipse.org/cdt/ and unpack it into your Eclipse folder, in our case /home/user/eclipse.
 * Download kdepim
-: As said, we use kdepim as example here. So, download ("checkout") kdepim using svn, e.g. as anonymous:
+: As said, we use kdepim as example here. So, download ("checkout") kdepim using Subversion, e.g. as anonymous:
- svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepim
+<syntaxhighlight lang="bash">
 : We assume you checked out into /home/user/kdepim.
 * Compile kdepim
-: Compile kdepim so the usual makefiles are present for all kdepim applications. If you have problems doing this, follow our [[Getting Started/Build|build instructions]]
+: Compile kdepim so the usual makefiles are present for all kdepim applications. If you have problems doing this, follow our [[Getting Started/Build|build instructions]].
-* Import your project into eclipse
+* Import your project into Eclipse
-: Surprise: To import your project, you should not use "File -&gt; Import". Rather do: File -> New -> C++ Project -> Makefile project -> Empty Project -> un-tag "use default location" -> choose /home/user/kdepim/ktimetracker. Call it "ktimetracker".
+: Surprise: To import your project, you cannot use "File -> Import". Rather do: File -> New -> C++ Project -> Makefile project -> Empty Project -> un-tag "use default location" -> choose /home/user/kdepim/ktimetracker. Call it "ktimetracker".
 * Build your project
@@ Line 53: / Line 55: @@
 ==== Custom builders ====
-If you want to integrate the cmake build step into your build toolchain, you will need to
+If you want to integrate the CMake build step into your build toolchain, you will need to
 * create a custom ''builder'' like this:
- cat >/bin/eclipsebuild<<EOF
+<syntaxhighlight lang="bash">
- cmake . && make -j4 && make install
+echo "cmake . && make -j4 && make install" >/bin/eclipsebuild
- EOF
+chmod 777 /bin/eclipsebuild
- chmod 777 /bin/eclipsebuild
+</syntaxhighlight>
-−
 * Add your builder
 : Choose Project -> Properties -> Builders. Un-tag all existing builders. Click "new" -> Program -> (name it "Builder for KDE"). -> Location: /bin/eclipsebuild -> Working directory /home/user/workspace/myproject1/kdepim.
 * Build
-: Now you can build your project. Every time after you restarted eclipse, choose myproject1 -> Project -> Properties -> C/C++ Build -> Ok -> Project -> Build.
+: Now you can build your project. Every time you restart eclipse, choose myproject1 -> Project -> Properties -> C/C++ Build -> Ok -> Project -> Build.
 ==== Revert what eclipse did ====
 To revert what eclipse did to your project simply run
- rm -rf .externalToolBuilders/ .project .cproject
+<syntaxhighlight lang="bash">
 ==== Why Subversion does not work ====
-When using eclipse's svn plugin and building a KDE program, you will get error messages complaining that your svn binary is too old. If you want to try and change this, here's how you get to that error:
+When using Eclipse's svn plugin and building a KDE program, you will get error messages complaining that your svn binary is too old. If you want to try and change this, here is how you get to that error:
-* Install the subversion plug-ins
+* Install the Subversion plug-ins
 : Help -> Software Updates -> Available Software -> Add Site -> http://download.eclipse.org/technology/subversive/0.7/update-site/ -> Add Site -> http://www.polarion.org/projects/subversive/download/eclipse/2.0/update-site/
@@ Line 84: / Line 87: @@
 * Click on Install
-* Restart eclipse
+* Restart Eclipse
 * Import your KDE module
@@ Line 104: / Line 107: @@
 Main article: [[Development/Tutorials/Using_Qt_Creator]]
-This describes how to use QtCreator to develop KDE 4 applications. It has been tested with QtCreator 1.2.80 and SUSE Linux 11.1 but should work same or similar with every combination. As an example KDE application we use [http://userbase.kde.org/ktimetracker ktimetracker] from the kdepim module, other applications should work same or similar.
+This describes how to use QtCreator to develop KDE 4 applications. It has been tested with QtCreator 1.2.80 and SUSE Linux 11.1 but should work same or similar with every combination. As an example KDE application we use [http://userbase.kde.org/ktimetracker ktimetracker] from the kdepim module, other applications should work likewise.
 === Load an existing project ===
@@ Line 110: / Line 113: @@
 * Import the CMakeLists.txt file
 File -> Open -> kdepim/CMakeLists.txt.
-* Configure qtcreator to build only ktimetracker
+* Configure QtCreator to build only ktimetracker
 Projects -> ktimetracker -> build settings -> Add a configuration ktimetracker.
-As build directory choose kdepim. As arguments for cmake use e.g.
+As build directory choose kdepim. As arguments for CMake use e.g.
- . -DCMAKE_INSTALL_PREFIX=/usr/local -DLIB_SUFFIX=64 -DCMAKE_BUILD_TYPE=debugfull
+<syntaxhighlight lang="cmake">
 === Start a KDE project ===
-To start a new project you need to tell qtcreator to use the KDE libraries when building. So, choose File -> New... and create your project. We will call it ''yourproject'' here. To be able to use KDE's libraries, go to your home directory, cd into ''yourproject'' and modify ''yourproject.pro''. Add a line
+To start a new project you need to tell QtCreator to use the KDE libraries when building. So, choose File -> New... and create your project. We will call it ''yourproject'' here. To be able to use KDE's libraries, go to your home directory, change into ''yourproject'' and modify the file ''yourproject.pro''. Add the line
- LIBS += -lkdeui
+<syntaxhighlight lang="cmake">
 == KDevelop 3 (outdated by KDevelop 4) ==
@@ Line 138: / Line 145: @@
 The following steps are all done with the ''kde-devel'' user. You need to login as that user by typing
- su - kde-devel
+<syntaxhighlight lang="bash">
 KDevelop has no native support for CMake projects. Fortunately, CMake has the ability to generate KDevelop project files itself. In order to do this, you need to pass the ''-GKDevelop3'' flag to the ''cmake'' command. This tells CMake to generate project files for KDevelop alongside the normal makefiles. The best way to do this is to modify your ''cmakekde'' function in your [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|{{path|.bashrc}}]]. Just change

@@ Line 98: / Line 98: @@
 == QtCreator ==
-    {|align="right"
+{|align="right"
-    |[[image:Snapshot-qtcreator.png|right|thumb|200px|KDE4's ktimetracker loaded as QtCreator project]]
+|[[image:Snapshot-qtcreator.png|right|thumb|200px|KDE4's ktimetracker loaded as QtCreator project]]
-    |}
+|}
 Main article: [[Development/Tutorials/Using_Qt_Creator]]

@@ Line 1: / Line 1: @@
-=== Eclipse ===
+= Eclipse =
      {|align="right"
@@ Line 15: / Line 15: @@
 * have call trees for your functions
-==== Set up Eclipse with KDE  ====
+== Set up Eclipse with KDE  ==
 * Check your requirements
@@ Line 49: / Line 49: @@
 : Choose Project -> Properties -> Run/Debug Settings -> New. As project, enter ''ktimetracker'', as C/C++ Application, enter /home/user/kdepim/ktimetracker/ktimetracker. Choose Apply -> Ok -> Ok. Now you can click on the "Run" button and start it.
-==== Know-How ====
+== Know-How ==
-===== Custom builders =====
+=== Custom builders ===
 If you want to integrate the cmake build step into your build toolchain, you will need to
@@ Line 66: / Line 66: @@
 : Now you can build your project. Every time after you restarted eclipse, choose myproject1 -> Project -> Properties -> C/C++ Build -> Ok -> Project -> Build.
-===== Revert what eclipse did =====
+=== Revert what eclipse did ===
 To revert what eclipse did to your project simply run
   rm -rf .externalToolBuilders/ .project .cproject
-===== Why Subversion does not work =====
+=== Why Subversion does not work ===
 When using eclipse's svn plugin and building a KDE program, you will get error messages complaining that your svn binary is too old. If you want to try and change this, here's how you get to that error:
@@ Line 92: / Line 92: @@
 : Choose Project -> Properties -> C/C++ Build -> Builder Settings. Un-tag "use default build command", set "cmake" instead. Choose Project -> Properties -> C/C++ Build -> Behavior. Replace "all" by ".".
-==== See also ====
+== See also ==
 * http://javathreads.de/2008/07/subversion-unter-eclipse-ganymede-konfigurieren/
 * http://nienhueser.de/blog/?p=19
-=== QtCreator ===
+= QtCreator =
      {|align="right"
      |[[image:Snapshot-qtcreator.png|right|thumb|200px|KDE4's ktimetracker loaded as QtCreator project]]
@@ Line 106: / Line 106: @@
 This describes how to use QtCreator to develop KDE 4 applications. It has been tested with QtCreator 1.2.80 and SUSE Linux 11.1 but should work same or similar with every combination. As an example KDE application we use [http://userbase.kde.org/ktimetracker ktimetracker] from the kdepim module, other applications should work same or similar.
-==== Load an existing project ====
+== Load an existing project ==
 As discussed here we use ktimetracker as example project.
 * Import the CMakeLists.txt file
@@ Line 116: / Line 116: @@
   . -DCMAKE_INSTALL_PREFIX=/usr/local -DLIB_SUFFIX=64 -DCMAKE_BUILD_TYPE=debugfull
-==== Start a KDE project ====
+== Start a KDE project ==
 To start a new project you need to tell qtcreator to use the KDE libraries when building. So, choose File -> New... and create your project. We will call it ''yourproject'' here. To be able to use KDE's libraries, go to your home directory, cd into ''yourproject'' and modify ''yourproject.pro''. Add a line
   LIBS += -lkdeui
-=== KDevelop 3 (outdated by KDevelop 4) ===
+= KDevelop 3 (outdated by KDevelop 4) =
 This section will explain how to use KDevelop 3.4 to develop KDE 4 applications. If you have any questions, corrections or rants about this section, please post them on the discussion page.
-==== Prerequisites ====
+== Prerequisites ==
 You need at least KDevelop 3.4 for this, which is still a KDE 3 application. Versions lower than 3.4 do not have Qt 4 support among other things. You can get KDevelop at the [http://www.kdevelop.org/index.html?filename=3.4/download.html KDevelop homepage]. Make sure you install KDevelop like all other KDE 3 applications, '''not''' with your ''kde-devel'' user.
@@ Line 200: / Line 200: @@
 -->
-===== TroubleShooting =====
+=== TroubleShooting ===
 '''Symptome:''' kdevelop says "cannot talk to klauncher". You cannot open a file.
@@ Line 207: / Line 207: @@
   export LD_LIBRARY_PATH=/opt/kde3/lib
-==== Setting up KDevelop ====
+== Setting up KDevelop ==
 Now that KDevelop has started, you need to adjust a few settings. Go to ''Settings->Configure KDevelop...->Documentation'' for this. Remove all entries that are not relevant to KDE 4 coding.
@@ Line 318: / Line 318: @@
 Now you have completed all essential configuration, congratulations!
-==== Using KDevelop ====
+== Using KDevelop ==
 Refer to the [http://docs.kde.org/development/en/kdevelop/kdevelop/ KDevelop manual] for general help using KDevelop. The following section will only deal with special cases for KDE 4.
-===== Debugging =====
+=== Debugging ===
 KDE apps have many symbols, which means that you need a lot of memory to get a decent loading times for debugging. To quote a GDB developer: "I would be reluctant to debug KDE on something with <1GB RAM."

← Older revision		Revision as of 10:39, 25 September 2011
Line 98:		Line 98:

	=== QtCreator ===		=== QtCreator ===
		+	{\|align="right"
		+	\|[[image:Snapshot-qtcreator.png\|right\|thumb\|200px\|KDE4's ktimetracker loaded as QtCreator project]]
		+	\|}
		+
	Main article: [[Development/Tutorials/Using_Qt_Creator]]		Main article: [[Development/Tutorials/Using_Qt_Creator]]