Difference between revisions of "Development/Tools"

Jump to: navigation, search
m (Adding Language Navigation Bar)
m (linkfix)
 
(30 intermediate revisions by 14 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Development/Tools}}
+
 
 
This section contains information about tools for KDE development.
 
This section contains information about tools for KDE development.
 +
 +
== Core Tools ==
 +
These are the tools that are absolutely required to build and develop KDE software.  On Linux, they will typically be provided by your distribution.  On other platforms, packages should normally be available, often for download directly from the home page for the tool.  Of course, the standard development tools, such as a C/C++ compiler and some sort of text editor, are also required.
 +
 +
; CMake
 +
: [[Development/CMake|CMake]] is KDE's build system of choice.  Once you have this, you can use it to configure a software project for building, and that process will tell you of any other requirements you are missing.
 +
 +
; Git
 +
: Most KDE projects are developed in [http://techbase.kde.org/Development/Git Git], and so you will need it to get the source code in the first place.  You can find the relevant Git URLs at the [http://projects.kde.org/ KDE projects directory].  It will be helpful to follow the [[Development/Git/Configuration|git configuration instructions]].
 +
 +
; Subversion
 +
: KDE still uses [[Getting Started/Sources/Subversion|Subversion]] for some things, notably translations.
  
 
== Debugging and Analysis ==
 
== Debugging and Analysis ==
Line 6: Line 18:
  
 
; Valgrind
 
; Valgrind
: [[/Valgrind|Valgrind]] helps to find memory leaks and uninitialized memory blocks. Additional features are a profiler and more. Valgrind is one of the most important development tools!
+
: [[Development/Tools/Valgrind|Valgrind]] helps to find memory leaks and uninitialized memory blocks. Additional features are a profiler and more. Valgrind is one of the most important development tools!
  
 
; The GNU Project Debugger (GDB)
 
; The GNU Project Debugger (GDB)
 
: [http://sources.redhat.com/gdb/ GDB] helps in debugging source code. As GDB evolved over time it is recommended to use version 6.x. Graphical frontends are available (see below). See also the debugging tutorial [[../Tutorials/Debugging/Debugging with GDB|Debugging with GDB]].
 
: [http://sources.redhat.com/gdb/ GDB] helps in debugging source code. As GDB evolved over time it is recommended to use version 6.x. Graphical frontends are available (see below). See also the debugging tutorial [[../Tutorials/Debugging/Debugging with GDB|Debugging with GDB]].
  
; KDbg
+
; KDbg and DDD
: [http://www.kdbg.org/ KDbg] is a graphical user interface to GDB, which is able to set breakpoints, step through the code etc.
+
: [http://www.kdbg.org/ KDbg] and [http://www.gnu.org/software/ddd/ DDD] are graphical user interfaces to GDB, which are able to set breakpoints, step through the code etc.
 +
 
 +
; MS Windows tools (Process Explorer, Console, WinDbg, DebugView...)
 +
: More info on the [[Projects/KDE_on_Windows/Tools|KDE on Windows page]].
  
 
== Development Tools ==
 
== Development Tools ==
 +
; Qt Creator
 +
: With Qt Creator it is easy to write new KDE based programs and to integrate existing ones into an IDE. Further details can be found in the tutorial [[Development/Tutorials/Using_Qt_Creator|Using Qt Creator]].
 +
 
; KDevelop
 
; KDevelop
: [http://www.kdevelop.org KDevelop] is an excellent IDE for developing KDE and Qt C++ applications. It includes a an integrated debugger, a powerful editor with syntax highlighting, a ''Project wizard'' to create applications from templates, the automake/autoconf gunk, and even the class documentation. Further details can also be found in the [http://kdevelop.org/mediawiki/index.php/Main_Page KDevelop wiki].
+
: [http://www.kdevelop.org KDevelop] is an IDE for developing KDE and Qt C++ applications. It includes a an integrated debugger, a powerful editor with syntax highlighting, a ''Project wizard'' to create applications from templates, the automake/autoconf gunk, and even the class documentation. Further details can also be found in the [http://userbase.kde.org/KDevelop4 wiki].
  
:Instructions on how to use KDevelop with KDE 4 applications is available at [[Getting_Started/Set_up_KDE_4_for_development#KDevelop|this page]]
+
; MS Visual Studio® Express IDE (Windows only)
 
+
: [http://www.microsoft.com/exPress/ Visual C++® Express] is the free version of the Microsoft Visual Studio compiler from Microsoft, which is officially supported by Nokia. It is a choice for compiling Qt and KDE applications on Windows. [[Projects/KDE_on_Windows/Issues/MSVC|more info...]]
; Qt Designer
+
: With Trolltechs [http://www.trolltech.com/products/qt/features/designer Qt Designer] it is easy to layout user interfaces like buttons and checkboxes. Additional features are undo/redo, checking accelerator conflicts etc. Qt Designer allows even non-programmers to help design KDE dialogs. Further details can be found in the tutorial [[Development/Tutorials/Using_Qt_Designer|Using Qt Designer]] and in the [http://doc.trolltech.com/4.2/designer-manual.html Qt documentation].
+
 
+
; MS Visual Studio® Express 2005 IDE (Windows only)
+
: Visual C++® 2005 Express Edition [http://www.microsoft.com/germany/msdn/vstudio/products/express/visualc/default.mspx] is the free version of the Microsoft Visual Studio 2000 compiler from Microsoft, which is official supported by Trolltech since QT 4.3.2 and a choice for compiling qt and kde applications on windows.
+
  
 
== Internationalization (i18n) Tools ==
 
== Internationalization (i18n) Tools ==
  
; KBabel
+
; Lokalize
: [http://kbabel.kde.org/ KBabel] is a set of tools for editing and managing gettext PO files. Its main part is a powerful and comfortable PO file editor which features full navigation capabilities, full editing functionality, possibility to search for translations in different dictionaries, spell and syntax checking, showing diffs and many more.
+
: [http://userbase.kde.org/Lokalize Lokalize] is a computer-aided translation system that focuses on productivity and quality assurance. It has components usual for CAT tools: translation memory, glossary, and also a unique translation merging (synchronization) capability. It is targeted for software translation and also integrates external conversion tools for freelance office document translation.
 
+
: Also included is a "Catalog Manager", a file manager view which helps keeping an overview of PO files. Last but not least it includes a standalone dictionary application as an additional possibility to access KBabel's powerful dictionaries. KBabel will help you to translate fast and also keep consistent translations.
+
  
 
; Dr. Klash
 
; Dr. Klash
: This little utility, once activated, can present a report about conflicting shortcuts in menus. Not only this is helpful for translators but also for developers. A little hand editing of {{path|`kde-config --localprefix`/share/config/kdeglobals}} activates this feature:
+
: This little utility, once activated, can present a report about conflicting shortcuts in menus. Not only is this helpful for translators but also for developers. A little hand editing of {{path|`kde-config --localprefix`/share/config/kdeglobals}} activates this feature:
  
<code ini>
+
<syntaxhighlight lang="ini">
 
[Development]
 
[Development]
 
CheckAccelerators=F12
 
CheckAccelerators=F12
 
AutoCheckAccelerators=false
 
AutoCheckAccelerators=false
 
AlwaysShowCheckAccelerators=false
 
AlwaysShowCheckAccelerators=false
</code>
+
</syntaxhighlight>
  
: Now pressing F12 will show a dialog containing which accelerators in the currently focussed interface conflict and provide suggestions for new accelerators. If no accelerators conflict or Dr. Klash has nothing to suggest, no popup dialog will not be displayed at all.  
+
: Pressing F12 will show a dialog containing which accelerators in the currently focussed interface conflict and provide suggestions for new accelerators. If no accelerators conflict or Dr. Klash has nothing to suggest, no popup dialog will be displayed.  
  
 
: With <tt>AutoCheckAccelerators</tt> enabled the dialog will popup automatically if a conflict exists and <tt>AlwaysShowCheckAccelerators</tt> can force the dialog to always popup even if there are no conflicts to report.  
 
: With <tt>AutoCheckAccelerators</tt> enabled the dialog will popup automatically if a conflict exists and <tt>AlwaysShowCheckAccelerators</tt> can force the dialog to always popup even if there are no conflicts to report.  
Line 51: Line 62:
  
 
: After you've built l10n-kde4/x-test and installed it, run your application using the "x-test" locale. This can be done by launching it from the command line like this:
 
: After you've built l10n-kde4/x-test and installed it, run your application using the "x-test" locale. This can be done by launching it from the command line like this:
 
+
<pre>
> KDE_LANG=x-test kspread
+
> KDE_LANG=x-test kspread
 
+
</pre>
 
: This will start KSpread using the "x-test" locale no matter what your current language setting is. Look for strings that do not have the xx's. If xx's are missing from a string, it could be due to missing i18n calls or even missing or incorrectly generated .pot files. Consult the i18n tutorials for further information.
 
: This will start KSpread using the "x-test" locale no matter what your current language setting is. Look for strings that do not have the xx's. If xx's are missing from a string, it could be due to missing i18n calls or even missing or incorrectly generated .pot files. Consult the i18n tutorials for further information.
  
Line 62: Line 73:
 
You can look at the translated .po files to see if a string is present and has been translated. For example, here's a portion of {{path|l10n/de/messages/kdebase/konqueror.po}}:  
 
You can look at the translated .po files to see if a string is present and has been translated. For example, here's a portion of {{path|l10n/de/messages/kdebase/konqueror.po}}:  
  
#: konq_mainwindow.cc:3707 konq_tabs.cc:84
+
<pre>
msgid "&New Tab"
+
#: konq_mainwindow.cc:3707 konq_tabs.cc:84
msgstr "Neues &Unterfenster"
+
msgid "&New Tab"
 +
msgstr "Neues &Unterfenster"
 +
</pre>
  
 
The string to be translated is given on the msgid line. The translated string is on the msgstr line. Notice that the exact same string to translate came from {{path|konq_mainwindow.cc}} and also from {{path|konq_tabs.cc}}. This saves the translators from having to translate the same identical string twice.  
 
The string to be translated is given on the msgid line. The translated string is on the msgstr line. Notice that the exact same string to translate came from {{path|konq_mainwindow.cc}} and also from {{path|konq_tabs.cc}}. This saves the translators from having to translate the same identical string twice.  
  
You can also use KBabel to examine {{path|.po}} files. KBabel is part of the kdesdk module.
+
You can also use Lokalize to examine {{path|.po}} files. Lokalize is part of the kdesdk module.
  
 
{{note|More information on writing and translating documentation can be found on [http://l10n.kde.org/ the l10n project site].}}
 
{{note|More information on writing and translating documentation can be found on [http://l10n.kde.org/ the l10n project site].}}
Line 74: Line 87:
 
== Helper Tools ==
 
== Helper Tools ==
  
; [[/Using kde-config|Get information about KDE's installation - kde-config]]  
+
;[[Development/Tools/Using kde-config|Get information about KDE's installation - kde-config]]  
 
: The tool kde-config helps to find out more about a KDE installation.
 
: The tool kde-config helps to find out more about a KDE installation.
  
; [[/Using kfmclient|Driving Konqueror From Scripts - kfmclient]]  
+
;[[Development/Tools/Using kfmclient|Driving Konqueror From Scripts - kfmclient]]  
 
: kfmclient is a small tool to communicate with Konqueror.
 
: kfmclient is a small tool to communicate with Konqueror.
  
;[[/Using kconf_update|Updating User Configuration Files - kconf_update]]
+
;[[Development/Tools/Using kconf_update|Updating User Configuration Files - kconf_update]]
 
: kconf_update is a tool designed to update config files.
 
: kconf_update is a tool designed to update config files.
 +
 +
;[[Development/Tools/apidox|Generating apidox]]
 +
: tools that help develop and generate API documentation for your code.
 +
 +
;[[Development/Tools/Automoc4|Automoc4]]
 +
: This is a helper tool needed to build KDE4. It automatically generates moc-files.
 +
 +
;[[Development/Tools/svnmerge.py|svnmerge.py]]
 +
: This tool helps keeping track of merges between different SVN branches
  
 
== Quality Assurance ==
 
== Quality Assurance ==
  
; Continuous Building - Dashboard
+
;Code Review
: [http://developer.kde.org/~dirk/dashboard/ all kde modules on Dirk's dashboard]
+
: KDE uses [http://www.reviewboard.org/ Review Board] for performing code reviews, see the [[Development/Review_Board|KDE Review Board]] page for more details
 +
 
 +
;Continuous Building - Jenkins
 +
: [http://build.kde.org Jenkins]
 
: [http://public.kitware.com/dashboard.php?name=kde kdelibs on kitware]
 
: [http://public.kitware.com/dashboard.php?name=kde kdelibs on kitware]
  
; [http://englishbreakfastnetwork.org/ English Breakfast Network] - Static Analysis
+
;[http://englishbreakfastnetwork.org/ English Breakfast Network] - Static Analysis
 
: [http://www.englishbreakfastnetwork.org/krazy/ Krazy ] - Code Analysis, [[Development/Tutorials/Code_Checking|Usage Tutorial]]
 
: [http://www.englishbreakfastnetwork.org/krazy/ Krazy ] - Code Analysis, [[Development/Tutorials/Code_Checking|Usage Tutorial]]
 
: [http://www.englishbreakfastnetwork.org/apidocs/ APIDOX] - API Documentation Statistics
 
: [http://www.englishbreakfastnetwork.org/apidocs/ APIDOX] - API Documentation Statistics
 
: [http://www.englishbreakfastnetwork.org/sanitizer/ Sanitizer] - DocBook Checker
 
: [http://www.englishbreakfastnetwork.org/sanitizer/ Sanitizer] - DocBook Checker
 
: [http://www.englishbreakfastnetwork.org/usability/ Usability Checks]
 
: [http://www.englishbreakfastnetwork.org/usability/ Usability Checks]

Latest revision as of 13:50, 22 January 2013

This section contains information about tools for KDE development.

Contents

[edit] Core Tools

These are the tools that are absolutely required to build and develop KDE software. On Linux, they will typically be provided by your distribution. On other platforms, packages should normally be available, often for download directly from the home page for the tool. Of course, the standard development tools, such as a C/C++ compiler and some sort of text editor, are also required.

CMake
CMake is KDE's build system of choice. Once you have this, you can use it to configure a software project for building, and that process will tell you of any other requirements you are missing.
Git
Most KDE projects are developed in Git, and so you will need it to get the source code in the first place. You can find the relevant Git URLs at the KDE projects directory. It will be helpful to follow the git configuration instructions.
Subversion
KDE still uses Subversion for some things, notably translations.

[edit] Debugging and Analysis

A list of tools which are used to analyze a program. This includes debuggers and profilers, for instance.

Valgrind
Valgrind helps to find memory leaks and uninitialized memory blocks. Additional features are a profiler and more. Valgrind is one of the most important development tools!
The GNU Project Debugger (GDB)
GDB helps in debugging source code. As GDB evolved over time it is recommended to use version 6.x. Graphical frontends are available (see below). See also the debugging tutorial Debugging with GDB.
KDbg and DDD
KDbg and DDD are graphical user interfaces to GDB, which are able to set breakpoints, step through the code etc.
MS Windows tools (Process Explorer, Console, WinDbg, DebugView...)
More info on the KDE on Windows page.

[edit] Development Tools

Qt Creator
With Qt Creator it is easy to write new KDE based programs and to integrate existing ones into an IDE. Further details can be found in the tutorial Using Qt Creator.
KDevelop
KDevelop is an IDE for developing KDE and Qt C++ applications. It includes a an integrated debugger, a powerful editor with syntax highlighting, a Project wizard to create applications from templates, the automake/autoconf gunk, and even the class documentation. Further details can also be found in the wiki.
MS Visual Studio® Express IDE (Windows only)
Visual C++® Express is the free version of the Microsoft Visual Studio compiler from Microsoft, which is officially supported by Nokia. It is a choice for compiling Qt and KDE applications on Windows. more info...

[edit] Internationalization (i18n) Tools

Lokalize
Lokalize is a computer-aided translation system that focuses on productivity and quality assurance. It has components usual for CAT tools: translation memory, glossary, and also a unique translation merging (synchronization) capability. It is targeted for software translation and also integrates external conversion tools for freelance office document translation.
Dr. Klash
This little utility, once activated, can present a report about conflicting shortcuts in menus. Not only is this helpful for translators but also for developers. A little hand editing of `kde-config --localprefix`/share/config/kdeglobals activates this feature:
[Development]
CheckAccelerators=F12
AutoCheckAccelerators=false
AlwaysShowCheckAccelerators=false
Pressing F12 will show a dialog containing which accelerators in the currently focussed interface conflict and provide suggestions for new accelerators. If no accelerators conflict or Dr. Klash has nothing to suggest, no popup dialog will be displayed.
With AutoCheckAccelerators enabled the dialog will popup automatically if a conflict exists and AlwaysShowCheckAccelerators can force the dialog to always popup even if there are no conflicts to report.
The x-test language
This helper language serves as a debugging aid for people finding untranslated strings in applications. If you start your application with the "x-test" locale, all translated strings will appear with trailing and leading xx's. First you have to check out these "translations" from l10n-kde4/x-test and install them.
After you've built l10n-kde4/x-test and installed it, run your application using the "x-test" locale. This can be done by launching it from the command line like this:
> KDE_LANG=x-test kspread
This will start KSpread using the "x-test" locale no matter what your current language setting is. Look for strings that do not have the xx's. If xx's are missing from a string, it could be due to missing i18n calls or even missing or incorrectly generated .pot files. Consult the i18n tutorials for further information.
When checking for untranslated strings, be sure to check all the WhatsThis help and tooltips.

[edit] Examining .po files

You can look at the translated .po files to see if a string is present and has been translated. For example, here's a portion of l10n/de/messages/kdebase/konqueror.po:

#: konq_mainwindow.cc:3707 konq_tabs.cc:84
msgid "&New Tab"
msgstr "Neues &Unterfenster"

The string to be translated is given on the msgid line. The translated string is on the msgstr line. Notice that the exact same string to translate came from konq_mainwindow.cc and also from konq_tabs.cc. This saves the translators from having to translate the same identical string twice.

You can also use Lokalize to examine .po files. Lokalize is part of the kdesdk module.

noframe
 
Note
More information on writing and translating documentation can be found on the l10n project site.

[edit] Helper Tools

Get information about KDE's installation - kde-config
The tool kde-config helps to find out more about a KDE installation.
Driving Konqueror From Scripts - kfmclient
kfmclient is a small tool to communicate with Konqueror.
Updating User Configuration Files - kconf_update
kconf_update is a tool designed to update config files.
Generating apidox
tools that help develop and generate API documentation for your code.
Automoc4
This is a helper tool needed to build KDE4. It automatically generates moc-files.
svnmerge.py
This tool helps keeping track of merges between different SVN branches

[edit] Quality Assurance

Code Review
KDE uses Review Board for performing code reviews, see the KDE Review Board page for more details
Continuous Building - Jenkins
Jenkins
kdelibs on kitware
English Breakfast Network - Static Analysis
Krazy - Code Analysis, Usage Tutorial
APIDOX - API Documentation Statistics
Sanitizer - DocBook Checker
Usability Checks

This page was last modified on 22 January 2013, at 13:50. This page has been accessed 50,295 times. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal