Development/Tools: Difference between revisions

From KDE TechBase
No edit summary
(English Breakfast Network is obsolete, point instead to community::Infrastructure/GitLab/CI/Static Code Analysis)
 
(81 intermediate revisions by 26 users not shown)
Line 1: Line 1:
__TOC__
<languages/>
This section contains information about tools for KDE development.
 
==Analysis==
<translate>
A list of tools which are used to analyze a program. This would include debuggers and profilers, for instance.
<!--T:1-->
=== [http://valgrind.kde.org/ Valgrind] ===
The KDE Community produces libraries and tools for software development but, aside from [https://www.qt.io/ Qt] and [https://cmake.org/ CMake], doesn't prescribe which one to use. Here is just a sample of the various tools you can use when developing software that uses KDE APIs or contributing to KDE applications themselves.
A tool for searching memory leaks and/or uninitialized memory. Also includes a profiler. Valgrind is surely one of the most important development tools!
 
=== [http://sources.redhat.com/gdb/ The GNU Project Debugger (GDB)]===
== Core Tools == <!--T:2-->
Sooner or later you may need a debugger. Here is one (probably gdb is already shipped with your distribution). You should use at least version 4.95. There are also grahpical frontends available for gdb (see below).
 
See also the [http://developer.kde.org/documentation/other/gdb-doc.html KDE GDB Debugging HOWTO]
<!--T:3-->
=== [http://members.nextra.at/johsixt/kdbg.html KDbg] ===
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.
A graphical user interface to gdb, which is able to set breakpoints, step through the code and so on.
 
=== [http://www.gnu.org/software/binutils/manual/gprof-2.9.1/gprof.html The GNU Profiler (GProf)] ===
<!--T:4-->
GProf is a profiler which is able to display which function takes how much time, how often it is called and so on. There is also a KDE frontend available which takes the same data files as the gprof command does. See below.
; CMake
=== [http://kprof.sourceforge.net/ KProf] ===
 
KProf is a tool that displays execution profiling generated by various code profilers (among them the GNU Profiler).
<!--T:5-->
== KDevelop ==
: [[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. '''NOTE: KDE Frameworks can also be used in QMake-based projects.''' 
This is a superb IDE for developing KDE and Qt C++ applications. It includes a an integrated debugger, a syntax highlighting editor, and of course a 'Project wizard' to handle the creation of the basic menu structures, the automake/autoconf gunk, and even the class documentation. For more details, see: [http://www.kdevelop.org/ http://www.kdevelop.org/]
 
==Qt Designer==
<!--T:6-->
The user interface designer that comes with Qt. Supports layout management, undo/redo, checking accelerator conflicts etc. etc. This is a tool that allows even non-programmers to help design dialogs of KDE applications.
; Git
For more details, see the [http://www.trolltech.com/products/qt/designer.html official website].
 
==i18n tools==
<!--T:7-->
You can find information on writing and translating documentation on [http://i18n.kde.org/ this dedicated site].
: Most KDE projects are developed in [http://techbase.kde.org/Development/Git Git], and so you will need it to get the latest development version of the source code.  KDE also provides source code tarballs for the most recent releases. You can find the relevant Git URLs at the [http://cgit.kde.org/ KDE Git repository browser].
 
<!--T:8-->
; Subversion
 
<!--T:9-->
: Some KDE projects still use [[Community:Infrastructure/Subversion|Subversion]] for some things, notably translations. Third-party developers mostly don't need to bother with this but contributors should take note of it.
 
== Development Environments and Editors == <!--T:10-->
 
<!--T:11-->
; Qt Creator
 
<!--T:12-->
: Qt application developers are most likely already using Qt Creator as their IDE. The good news is that they don't need to switch away from it just to use KDE Frameworks. Simply add the appropriate module to the QMake project file as indicated by each one's API documentation and you're good to go.
 
<!--T:13-->
; KDevelop
 
<!--T:14-->
: [http://www.kdevelop.org KDevelop] is a powerful IDE for developing KDE and Qt C++ applications. Unlike Qt Creator, however, it isn't limited to just that use case and supports other languages, libraries, and tools as well.
 
<!--T:15-->
; Kate
 
<!--T:16-->
: Although not exactly an IDE, KDE's premiere [https://kate-editor.org/ Advanced Text Editor] has features and plugins that simplify the software development workflow, from syntax highlighting and code folding to project management to an embedded terminal emulator.
 
== Debugging and Analysis == <!--T:17-->
 
<!--T:18-->
There is a wide variety of tools available, especially on Linux that analyze code and profile applications. Here are some of the more popular ones.
 
<!--T:19-->
; Valgrind
 
<!--T:20-->
: [http://www.valgrind.org/ 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!
 
<!--T:21-->
; The GNU Project Debugger (GDB)
 
<!--T:22-->
: [http://sources.redhat.com/gdb/ GDB] helps in debugging source code. A graphical frontend, like the two below, might be a preferable way to use this tool.
 
<!--T:23-->
; KDbg and DDD
 
<!--T:24-->
: [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.
 
<!--T:25-->
For some tips on KDE software analysis and profiling, please visit the [[Community:Guidelines_and_HOWTOs/Debugging|Debugging page]] of the KDE Community Wiki.
 
== Translation == <!--T:26-->
 
<!--T:27-->
Most Qt projects use the framework's built-in translation system. For KDE projects, please see the [[Community:Guidelines_and_HOWTOs/Internationalization|Community Internationalization Guide]].
 
== Helper Tools == <!--T:28-->
 
<!--T:29-->
Here are some command-line tools that can assist developers in some of their day-to-day tasks.
 
<!--T:30-->
;[[Development/Tools/Using kde-config|kf5-config]]  
 
<!--T:31-->
: Provides information related to the installation of KDE libraries and applications, particularly paths and prefixes.
 
<!--T:32-->
;[[Development/Tools/Using kfmclient|kioclient5]]
 
<!--T:33-->
: Performs network-transparent operations (via the KIO framework) on the command line, like copying or even downloading files.
 
<!--T:34-->
;[[Development/Tools/Using kconf_update|kconf_update]]
 
<!--T:35-->
: Automates updating config files.
 
<!--T:36-->
;[[Development/Tools/apidox|kapidox]]
 
<!--T:37-->
: Generates API documentation for Doxygen-marked code.
 
== Quality Assurance == <!--T:38-->
 
<!--T:39-->
KDE contributors and third-party developers interested in monitoring the community's software development activities can take a peek via the sites and tools below.
 
<!--T:40-->
;Project Management
 
<!--T:41-->
: KDE currently uses [https://phabricator.kde.org/ Phabricator] for project management but is also moving to a [https://invent.kde.org/ Gitlab instance].
 
<!--T:42-->
;Continuous Building
 
<!--T:43-->
: To ensure high-quality, KDE software operates a [http://build.kde.org continuous integration system] powered by [https://jenkins.io/ Jenkins].
 
<!--T:44-->
;Static Analysis
 
<!--T:45-->
: KDE's continuous integration tooling performs static code analysis, see [[community::Infrastructure/GitLab/CI/Static Code Analysis]]
</translate>

Latest revision as of 22:42, 8 September 2022

Other languages:

The KDE Community produces libraries and tools for software development but, aside from Qt and CMake, doesn't prescribe which one to use. Here is just a sample of the various tools you can use when developing software that uses KDE APIs or contributing to KDE applications themselves.

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. NOTE: KDE Frameworks can also be used in QMake-based projects.
Git
Most KDE projects are developed in Git, and so you will need it to get the latest development version of the source code. KDE also provides source code tarballs for the most recent releases. You can find the relevant Git URLs at the KDE Git repository browser.
Subversion
Some KDE projects still use Subversion for some things, notably translations. Third-party developers mostly don't need to bother with this but contributors should take note of it.

Development Environments and Editors

Qt Creator
Qt application developers are most likely already using Qt Creator as their IDE. The good news is that they don't need to switch away from it just to use KDE Frameworks. Simply add the appropriate module to the QMake project file as indicated by each one's API documentation and you're good to go.
KDevelop
KDevelop is a powerful IDE for developing KDE and Qt C++ applications. Unlike Qt Creator, however, it isn't limited to just that use case and supports other languages, libraries, and tools as well.
Kate
Although not exactly an IDE, KDE's premiere Advanced Text Editor has features and plugins that simplify the software development workflow, from syntax highlighting and code folding to project management to an embedded terminal emulator.

Debugging and Analysis

There is a wide variety of tools available, especially on Linux that analyze code and profile applications. Here are some of the more popular ones.

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. A graphical frontend, like the two below, might be a preferable way to use this tool.
KDbg and DDD
KDbg and DDD are graphical user interfaces to GDB, which are able to set breakpoints, step through the code, etc.

For some tips on KDE software analysis and profiling, please visit the Debugging page of the KDE Community Wiki.

Translation

Most Qt projects use the framework's built-in translation system. For KDE projects, please see the Community Internationalization Guide.

Helper Tools

Here are some command-line tools that can assist developers in some of their day-to-day tasks.

kf5-config
Provides information related to the installation of KDE libraries and applications, particularly paths and prefixes.
kioclient5
Performs network-transparent operations (via the KIO framework) on the command line, like copying or even downloading files.
kconf_update
Automates updating config files.
kapidox
Generates API documentation for Doxygen-marked code.

Quality Assurance

KDE contributors and third-party developers interested in monitoring the community's software development activities can take a peek via the sites and tools below.

Project Management
KDE currently uses Phabricator for project management but is also moving to a Gitlab instance.
Continuous Building
To ensure high-quality, KDE software operates a continuous integration system powered by Jenkins.
Static Analysis
KDE's continuous integration tooling performs static code analysis, see community::Infrastructure/GitLab/CI/Static Code Analysis
Retrieved from "https://techbase.kde.org/index.php?title=Development/Tools&oldid=106920"