Jump to content

Get Involved/development/More: Difference between revisions

From KDE Community Wiki
← Older edit
Ashark (talk | contribs)
webadmin
287 edits
→Build Qt: No need to repeat this section for different version.
Nmariusp (talk | contribs)
989 edits
→Develop in a Linux container: KDE PIM docker uses a too old docker image from 2022
 
(48 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page is the continuation with more advanced topics of the page [[Get_Involved/development]].
This page is the continuation with more advanced topics of the page [[Get_Involved/development]].


== kde-builder ==
kde-builder has replaced the previous KDE build framework named kdesrc-build.
 
kde-builder is a drop in replacement of kdesrc-build. kdesrc-build is written in Perl. kde-builder is written in Python.
 
<pre>
mkdir -p ~/Development
cd ~/Development
git clone https://invent.kde.org/ashark/kde-builder.git
cd kde-builder
python3 -m venv .venv
# I use bash.
source .venv/bin/activate
pip install pipenv
pipenv install
./kde-builder --initial-setup <<< 'N'
mv ~/.config/kdesrc-buildrc .
sed -i 's_~/kde/_~/Development/_g' kdesrc-buildrc
# Edit the file ./kdesrc-buildrc as needed.
kate kdesrc-buildrc &
# meld kdesrc-buildrc ~/kde/src/kdesrc-build/kdesrc-buildrc
 
# kde-builder is installed.
# Use ./kde-builder instead of ./kdesrc-build. The command lines are the same.
# Use ./kde-builder-launch instead of ./kdesrc-run. The command lines are the same.
 
./kde-builder kconfig
./kde-builder kcalc
./kde-builder-launch kcalc
./kde-builder frameworks
</pre>


== Develop in a Linux container ==
== Develop in a Linux container ==


When you start programming for KDE, it is recommended that you [[Get_Involved/development|use kdesrc-build in your main operating system or in a virtual machine]] running on a rolling-release Linux distribution (Arch, openSUSE Tumbleweed, KDE neon) or running on e.g. the latest version of Fedora KDE Spin or Kubuntu.
When you start programming for KDE, it is recommended that you [[Get_Involved/development|use kde-builder in your main operating system or in a virtual machine]] running on a [[Get_Involved/development#Operating_system|Linux operating system that is better supported by kde-builder]].


As an alternative, you can run kdesrc-build in a Linux container (docker, podman, toolbx, distrobox).
As an alternative, you can run kde-builder in a Linux container (docker, podman, toolbx, distrobox).


=== Option 1. The KDE PIM Docker image ===
=== distrobox ===
 
You can install Docker and the [[KDE PIM/Docker|KDE PIM Docker image]]. It provides a development environment that is isolated from your day-to-day system. It is based on KDE Neon Unstable.
 
=== Option 2. distrobox ===


It is possible to start developing KDE software using container images that are able to see inside your home folder. This can be done using distrobox and podman.
It is possible to start developing KDE software using container images that are able to see inside your home folder. This can be done using distrobox and podman.


First, install distrobox and podman from your distribution repositories:
This solution is particularly useful for users on immutable distributions like Fedora Kinoite, openSUSE Kalpa or Valve's SteamOS 3


* Debian/Ubuntu: sudo apt install distrobox podman
To learn how to build KDE software with distrobox, see: https://develop.kde.org/docs/getting-started/building/containers-distrobox/
* openSUSE: sudo zypper install distrobox podman
* Fedora: sudo dnf install distrobox podman
* Arch: sudo pacman --sync distrobox podman


==== Building without kdesrc-build ====
== Other operating systems ==
 
You can build a single repository using the [https://community.kde.org/Neon/Containers KDE Neon Unstable docker image]. We will be using the <code>plasma:unstable</code> image, which comes with the latest KDE software and libraries, and we will be using the minimal version, which requires you to install development libraries before compiling your projects.


After installing distrobox and podman, run the following to create a new distrobox container:
=== Kubuntu >= 24.10 ===


{{Input|
The default configuration of kde-builder requires Qt version 6.7. Kubuntu 24.10 has Qt version 6.6. It is recommended that you use a [[Get_Involved/development#Operating_system|Linux OS that is better supported by kde-builder]].
podman pull invent-registry.kde.org/neon/docker-images/plasma:unstable
distrobox create --image invent-registry.kde.org/neon/docker-images/plasma:unstable
}}


This will create a distrobox container named '''plasma-unstable'''.
If you are a more seasoned developer you might be able to use Kubuntu for kde-builder by [https://develop.kde.org/docs/getting-started/building/kde-builder-setup/#qt6-online installing Qt6 using the Qt online installer] or by [https://develop.kde.org/docs/getting-started/building/kde-builder-setup/#qt6-build building Qt6 using kde-builder].


{{Note|The plasma:unstable image size is 5.6 GB.}}
=== Alpine Linux ===


Lastly, enter the generated container:
<pre>
 
apk add git perl doas-sudo-shim
{{Input|
</pre>
distrobox enter plasma-unstable
}}
 
You can then just clone the desired repository in your home folder and build it while being inside the container. If any development libraries are missing, you can just install them the same way you would install on Debian/Ubuntu/KDE Neon:
 
{{Input|
sudo apt install packagename-dev
}}
 
You can also use <code>build-dep</code> to let apt install the required libraries for the program you will be compiling. For example, to install the development libraries for Kate, you can run:
 
{{Input|
sudo apt-get build-dep kate
}}
 
==== Building with kdesrc-build ====
 
First, install distrobox and podman from your distribution repositories. Then run:
 
{{Input|
distrobox enter
}}
 
This should create a container based on your current Linux OS and enter it. It is preferable to use one of the Linux distributions that is better suited for kdesrc-build, as mentioned [[Get_Involved/development#Operating_system|in this wiki page]], so if your distribution does not provide very up-to-date packages, you can download and use a different container image for your distrobox from [https://hub.docker.com/search?type=image Dockerhub]. For example, with openSUSE Tumbleweed:
 
{{Input|
podman pull opensuse/tumbleweed
distrobox create --image opensuse/tumbleweed --name tumbleweed
distrobox enter tumbleweed
}}
 
Then it's a matter of downloading and running kdesrc-build as detailed in [[Get_Involved/development/Set_up_a_development_environment]]:
 
<syntaxhighlight lang="bash">
mkdir -p ~/kde/src
cd ~/kde/src
git clone https://invent.kde.org/sdk/kdesrc-build.git
cd kdesrc-build
./kdesrc-build --initial-setup
source ~/.bashrc
</syntaxhighlight>
 
From this point on, one important thing to bear in mind is that a distrobox container is transparent in its user space and containerized in its root space: when you are inside a distrobox container, you can see the content of system's home folder, but not your system's root folders, only the container's root folders. This means that you can install packages inside the container using root privileges and access those packages to compile your programs stored in your home, without ever installing those packages in your actual system!
 
You can take advantage of this by installing, for instance, Qt development packages used for kdesrc-build from inside the container. This way, it is not necessary to compile Qt with kdesrc-build. This is particularly convenient if you want to compile KDE software with Qt6 quickly.
 
Likewise, you should [https://community.kde.org/Get_Involved/development/Install_the_dependencies install the required dependencies] from inside the distrobox rather than from your system's repositories. Then you can start compiling as usual.
 
After compiling your program with kdesrc-build from inside the distrobox, you can run it with <code>kdesrc-build run</code>, and despite it originating from inside a container and using the libraries from the container, it will run just fine as a GUI application on your system!
 
The only few gotchas to using this method are:
 
* You cannot use a [[Get_Involved/development/Build_software_with_kdesrc-build#Plasma|full Plasma Desktop session]] made from git.
* You will need qqc2-desktop-style and Breeze to show the correct theme for your applications.
* You will need the QtWayland library and its respective development package to run your applications natively on a Wayland session.
 
== Other operating systems ==
 
=== Kubuntu 23.10 ===
 
The default configuration of kdesrc-build requires Qt version 6.6. Kubuntu 23.10 has Qt version 6.4.2. It is recommended that you [[Get_Involved/development/More#Build_Qt6_using_kdesrc-build|build Qt in Kubuntu]] or use a [[Get_Involved/development#Operating_system|Linux OS that is better supported by kdesrc-build]].


=== FreeBSD ===
=== FreeBSD ===
Line 145: Line 43:
</pre>
</pre>


Then set up kdesrc-build using the same procedure as when installing kdesrc-build on a Linux operating system. FreeBSD is currently supported by kdesrc-build. See https://www.youtube.com/watch?v=8MqBnb3Y9JU
Then set up kde-builder using the same procedure as when installing kde-builder on a Linux operating system. FreeBSD is currently supported by kde-builder. See https://www.youtube.com/watch?v=AhDHUg81M_I and https://www.youtube.com/watch?v=HRiKzaw8cAw .


=== Microsoft Windows ===
=== OpenBSD >= 7.5 ===


You can build and develop KDE projects using the [[Get_Involved/development/Windows|Microsoft Windows]] operating system.
Install OpenBSD version greater than or equal to 7.5. In the installer keep the defaults, the user created by the installer is named "administrator" in this example.
<pre>
# Enable doas
su -
cp /etc/examples/doas.conf /etc/doas.conf
exit
# kde-builder needs sudo.
mkdir -p ~/.local/bin ; ln -s /usr/bin/doas ~/.local/bin/sudo
echo "export PATH=~/.local/bin:\$PATH" >> ~/.bashrc


=== Apple macOS ===
# Test doas.
doas su
# kde-builder needs bash.
pkg_add bash
chsh -s /usr/local/bin/bash
exit


You can build and develop KDE projects using the [[Get_Involved/development/Mac|Apple macOS]] operating system.
# As user administrator
chsh -s /usr/local/bin/bash


== What to do if CMake configure fails because a build dependency is missing ==
# As per https://rsadowski.de/posts/2024-01-09-openbsd-kde/ , https://openports.pl/path/meta/kde,-plasma
doas su
pkg_add kde-plasma kate


See https://community.kde.org/Get_Involved/development/Install_the_dependencies .
# I recommend that you use tigervnc. https://nmariusp.github.io/install-os.html#openbsd--75
</pre>


== Advanced kdesrc-build ==
After you install kde-builder:
<pre>
# Edit the kdesrc-buildrc file e.g.:
cmake-options -DCMAKE_BUILD_TYPE=RelWithDebInfo -DKF_IGNORE_PLATFORM_CHECK=ON


After you have edited a git repository and you want to build it, <code>--no-src</code> will make sure that <code>kdesrc-build</code> does not overwrite your local source code changes with the latest source code from the official git repository (remote "origin" / https://invent/kde.org).
# Also set environment variable:
export CMAKE_PREFIX_PATH=/usr/local/lib/qt6/cmake
# Or
export CMAKE_PREFIX_PATH=/usr/local/lib/qt5/cmake
</pre>


<code>--no-include-dependencies</code> only builds the git repository that you give as parameter to <code>kdesrc-build</code>.
=== Microsoft Windows ===


<code>--debug</code> shows verbose output.
You can build and develop KDE projects using the [[Get_Involved/development/Windows|Microsoft Windows]] operating system.


<code>--refresh-build</code> forces a rebuild (not an incremental build) and a full reinstall.
=== Apple macOS ===


E.g. you have edited kcalc. You run:
You can build and develop KDE projects using the [[Get_Involved/development/Mac|Apple macOS]] operating system.
<pre>
kdesrc-build kcalc --no-src --no-include-dependencies --refresh-build --debug |& tee ~/a.txt
</pre>


For details, see:
== Project Documentation ==
<pre>
kdesrc-build --help
</pre>


Note: the resources below might not be up to date.
* https://kde-builder.kde.org
 
* https://invent.kde.org/sdk/kde-builder
See the [https://docs.kde.org/trunk5/en/kdesrc-build/kdesrc-build/ kdesrc-build manual], [https://invent.kde.org/sdk/kdesrc-build/-/blob/master/README.md Readme #1], [https://invent.kde.org/sdk/kdesrc-build/-/blob/master/doc/README.md Readme #2], [https://invent.kde.org/sdk/kdesrc-build/-/blob/master/doc/source-reference/index.adoc Document #3] for more kdesrc-build information and options.


== kf6-qt6 vs. kf5-qt5 ==
== kf6-qt6 vs. kf5-qt5 ==


Many KDE git repositories can build correctly and run correctly using "kdesrc-build kf6-qt6".  
Many KDE git repositories can build correctly and run correctly using "kde-builder kf6-qt6".  


The KDE git repositories that can build correctly and run correctly using "kdesrc-build kf6-qt6" have two long lived git branches:
The KDE git repositories that can build correctly and run correctly using "kde-builder kf6-qt6" have two long lived git branches:


* A long lived git branch that does not contain the deprecated symbols from kf5-qt5, named e.g. "master".
* A long lived git branch that does not contain the deprecated symbols from kf5-qt5, named e.g. "master".
* And another long lived git branch for qt5-kf5, where the deprecated symbols still exist.
* And another long lived git branch for qt5-kf5, where the deprecated symbols still exist.


What is "kf6-qt6"? You just set up kdesrc-build following the procedure. The resulting kdesrc-build installation will be of type kf6-qt6. In kdesrc-buildrc in the "global" section you will have "branch-group kf6-qt6". The git repositories that have only one long lived git branch e.g. named "master" will use that. The git repositories that have a second long lived git branch, will use the git branch where the deprecated symbols do not exist e.g. named "master".
What is "kf6-qt6"? You just set up kde-builder following the procedure. The resulting kde-builder installation will be of type kf6-qt6. In kde-builder.yaml in the "global:" section you will have "branch-group: kf6-qt6". The git repositories that have only one long lived git branch e.g. named "master" will use that. The git repositories that have a second long lived git branch, will use the git branch where the deprecated symbols do not exist e.g. named "master".


What is "kf5-qt5"? Follow the chapter "kdesrc-build Qt5". The resulting kdesrc-build installation will be of type kf5-qt5. In kdesrc-buildrc in the "global" section you will have "branch-group kf5-qt5". The git repositories that have only one long lived git branch e.g. named "master" will use that. The git repositories that have a second long lived git branch where the deprecated symbols still exist e.g. named "kf5" will use that.
What is "kf5-qt5"? Follow the chapter "kde-builder Qt5". The resulting kde-builder installation will be of type kf5-qt5. In kde-builder.yaml in the "global:" section you will have "branch-group: kf5-qt5". The git repositories that have only one long lived git branch e.g. named "master" will use that. The git repositories that have a second long lived git branch where the deprecated symbols still exist e.g. named "kf5" will use that.


== Build Qt using kdesrc-build ==
== Two independent kde-builder configurations: kf6-qt6 and kf5-qt5 ==
 
If you cannot build the KDE frameworks using {{ic|kdesrc-build}} and the Qt provided by your Linux distribution is outdated, you might want to build it using {{ic|kdesrc-build}}.
 
In your configuration file use the {{ic|qt-install-dir}} option (in the ''global'' section) with non-empty value, for example:
 
{{bc|
global
  qt-install-dir ~/kde6/usr_qt
  branch-group kf6-qt6
end global
}}
 
Then build it: {{bc|kdesrc-build qt6-set}}
 
If you want the same for Qt5, change {{ic|branch-group}} option and use {{ic|qt5-set}} instead of {{ic|qt6-set}}.
 
To compile Qt6 with Qt X11 Extras (which is a necessary library to compile [https://api.kde.org/frameworks/kwindowsystem/html/ KWindowSystem]), you should enable XCB feature during compilation
 
{{bc|1=kdesrc-build qt6-set --cmake-options="-DQT_FEATURE_xcb=ON"}}
 
After that, you can build other modules.
 
== Two independent kdesrc-build configurations: kf6-qt6 and kf5-qt5 ==


You can switch between configurations with {{ic|--rc-file}} command line option. Generate another config, make the changes for the {{ic|source-dir}}, {{ic|build-dir}}, {{ic|install-dir}},
You can switch between configurations with {{ic|--rc-file}} command line option. Generate another config, make the changes for the {{ic|source-dir}}, {{ic|build-dir}}, {{ic|install-dir}},
Line 238: Line 130:
}}
}}


== Other CPU architectures than x86_64/amd64 and x86 ==
== Other CPU architectures than x86_64/amd64 ==


You can build and develop KDE projects using a Linux OS installed on an [[Get_Involved/development/ARM|ARM]] architecture CPU.
You can build and develop KDE projects using a Linux OS installed on an [[Get_Involved/development/ARM|ARM]] architecture CPU.


== kdesrc-build issues ==
== kde-builder issues ==


See https://community.kde.org/Get_Involved/development/Install_the_dependencies
=== "kde-builder kpat" fails because of black-hole-solitaire ===
 
=== wayland-protocols is too old, e.g. "kdesrc-build kidletime" fails ===
 
<pre>
mkdir -p ~/kde/misc && cd ~/kde/misc
wget https://gitlab.freedesktop.org/wayland/wayland-protocols/-/releases/1.31/downloads/wayland-protocols-1.31.tar.xz
tar -xJvf wayland-protocols-*.tar.xz && mv wayland-protocols-*/ wayland-protocols
cd wayland-protocols
meson setup builddir --prefix $HOME/kde/usr
meson compile -C builddir
meson install -C builddir
</pre>
 
=== "kdesrc-build kpat" fails because of black-hole-solitaire ===


This happens on Debian/Ubuntu/Kubuntu. Because there is no Linux distribution binary package for https://github.com/shlomif/black-hole-solitaire.
This happens on Debian/Ubuntu/Kubuntu. Because there is no Linux distribution binary package for https://github.com/shlomif/black-hole-solitaire.
Line 267: Line 145:
     cmake-options -DWITH_BH_SOLVER=OFF
     cmake-options -DWITH_BH_SOLVER=OFF
end options
end options
</pre>
=== libdisplay-info is not available ===
If your Linux OS does not have a package for libdisplay-info.
Append at the end of the file <code>kdesrc-buildrc</code>:
<pre>
module libdisplay-info
  repository https://gitlab.freedesktop.org/emersion/libdisplay-info.git
end module
</pre>
</pre>

Latest revision as of 23:17, 22 December 2024

This page is the continuation with more advanced topics of the page Get_Involved/development.

kde-builder has replaced the previous KDE build framework named kdesrc-build.

Develop in a Linux container

When you start programming for KDE, it is recommended that you use kde-builder in your main operating system or in a virtual machine running on a Linux operating system that is better supported by kde-builder.

As an alternative, you can run kde-builder in a Linux container (docker, podman, toolbx, distrobox).

distrobox

It is possible to start developing KDE software using container images that are able to see inside your home folder. This can be done using distrobox and podman.

This solution is particularly useful for users on immutable distributions like Fedora Kinoite, openSUSE Kalpa or Valve's SteamOS 3

To learn how to build KDE software with distrobox, see: https://develop.kde.org/docs/getting-started/building/containers-distrobox/

Other operating systems

Kubuntu >= 24.10

The default configuration of kde-builder requires Qt version 6.7. Kubuntu 24.10 has Qt version 6.6. It is recommended that you use a Linux OS that is better supported by kde-builder.

If you are a more seasoned developer you might be able to use Kubuntu for kde-builder by installing Qt6 using the Qt online installer or by building Qt6 using kde-builder.

Alpine Linux

apk add git perl doas-sudo-shim

FreeBSD

Install the latest release of FreeBSD with KDE Plasma Desktop on your hardware computer or in a virtual machine.

Your user should be member of the "wheel" user group (e.g. this can be configured in the FreeBSD installer, when creating your user you can select additional user groups for your user). Your user should be able to use sudo: 

pkg install sudo
visudo
# Uncomment the line: %wheel ALL=(ALL:ALL) ALL

Then set up kde-builder using the same procedure as when installing kde-builder on a Linux operating system. FreeBSD is currently supported by kde-builder. See https://www.youtube.com/watch?v=AhDHUg81M_I and https://www.youtube.com/watch?v=HRiKzaw8cAw .

OpenBSD >= 7.5

Install OpenBSD version greater than or equal to 7.5. In the installer keep the defaults, the user created by the installer is named "administrator" in this example. 

# Enable doas
su -
cp /etc/examples/doas.conf /etc/doas.conf
exit
# kde-builder needs sudo.
mkdir -p ~/.local/bin ; ln -s /usr/bin/doas ~/.local/bin/sudo
echo "export PATH=~/.local/bin:\$PATH" >> ~/.bashrc

# Test doas.
doas su
# kde-builder needs bash.
pkg_add bash
chsh -s /usr/local/bin/bash
exit

# As user administrator
chsh -s /usr/local/bin/bash

# As per https://rsadowski.de/posts/2024-01-09-openbsd-kde/ , https://openports.pl/path/meta/kde,-plasma
doas su
pkg_add kde-plasma kate

# I recommend that you use tigervnc. https://nmariusp.github.io/install-os.html#openbsd--75

After you install kde-builder: 

# Edit the kdesrc-buildrc file e.g.:
cmake-options -DCMAKE_BUILD_TYPE=RelWithDebInfo -DKF_IGNORE_PLATFORM_CHECK=ON

# Also set environment variable:
export CMAKE_PREFIX_PATH=/usr/local/lib/qt6/cmake
# Or
export CMAKE_PREFIX_PATH=/usr/local/lib/qt5/cmake

Microsoft Windows

You can build and develop KDE projects using the Microsoft Windows operating system.

Apple macOS

You can build and develop KDE projects using the Apple macOS operating system.

Project Documentation

kf6-qt6 vs. kf5-qt5

Many KDE git repositories can build correctly and run correctly using "kde-builder kf6-qt6".

The KDE git repositories that can build correctly and run correctly using "kde-builder kf6-qt6" have two long lived git branches:

  • A long lived git branch that does not contain the deprecated symbols from kf5-qt5, named e.g. "master".
  • And another long lived git branch for qt5-kf5, where the deprecated symbols still exist.

What is "kf6-qt6"? You just set up kde-builder following the procedure. The resulting kde-builder installation will be of type kf6-qt6. In kde-builder.yaml in the "global:" section you will have "branch-group: kf6-qt6". The git repositories that have only one long lived git branch e.g. named "master" will use that. The git repositories that have a second long lived git branch, will use the git branch where the deprecated symbols do not exist e.g. named "master".

What is "kf5-qt5"? Follow the chapter "kde-builder Qt5". The resulting kde-builder installation will be of type kf5-qt5. In kde-builder.yaml in the "global:" section you will have "branch-group: kf5-qt5". The git repositories that have only one long lived git branch e.g. named "master" will use that. The git repositories that have a second long lived git branch where the deprecated symbols still exist e.g. named "kf5" will use that.

Two independent kde-builder configurations: kf6-qt6 and kf5-qt5

You can switch between configurations with --rc-file command line option. Generate another config, make the changes for the source-dir, build-dir, install-dir, and other changes you want. Make sure you use different value for persistent-data-file option, to not mix things up.

As an alternative, you can utilize custom variable to make switch from a single config: 

global
    _ver 5  # <-- Change this to switch
    source-dir ~/kde${_ver}/src
    build-dir ~/kde${_ver}/build
    install-dir ~/kde${_ver}/usr
    persistent-data-file ~/kde${_ver}/persistent-options.json
end global

include ~/.local/share/kdesrc-build/data/build-include/kf${_ver}-qt${_ver}.ksb

Other CPU architectures than x86_64/amd64

You can build and develop KDE projects using a Linux OS installed on an ARM architecture CPU.

kde-builder issues

"kde-builder kpat" fails because of black-hole-solitaire

This happens on Debian/Ubuntu/Kubuntu. Because there is no Linux distribution binary package for https://github.com/shlomif/black-hole-solitaire.

Solution: append at the end of kdesrc-buildrc file: 

options kpat
    cmake-options -DWITH_BH_SOLVER=OFF
end options
Retrieved from "https://community.kde.org/index.php?title=Get_Involved/development/More&oldid=102486"