Filing a Bug Report

Bugs happen. That is a fact. But they can be fixed. And the better a bug report is the easier it is for the development team to replicate, investigate, and eventually fix it.

All bug reports need to be logged in the official bug tracker. And feature requests are tracked there as well using the severity item wishlist.

First Things First

But before you do, please do the following:

Step 1: Upgrade to the latest release

Please upgrade to the latest released versions of Kdenlive. We do not answer bug reports for old Kdenlive versions (unless they are still reproducible in the latest version).

Step 2: Search the official Kdenlive documentation

RTFM - Read The Fine Manual is a phrase often used to mock users asking questions that could be answered by reading the documentation. In the days and age of YouTube tutorial this may not be as important or relevant anymore, but you are encouraged to consult the official Kdenlive documentation. It can be searched and contains a wealth of good and valuable information.

Step 3: Search the forums

Kdenlive has a large community that is active in forums and chat rooms. Check the official forum on Discuss whether other users encountered the same issue. Perhaps a fix or workaround exists. Other channels to check are

Step 4: Query open issues

Search the bug tracker. Perhaps the issue you are experiencing has already been reported or is even being worked on. The bug’s status is a good indicator for what is currently happening:

  • REPORTED is a bug that has been reported but nothing has happened so far. There may be a discussion about it, so it is worth checking if it may apply to your issue.

  • NEEDSINFO is a reported bug, which needs more feedback. This means, a dev team member looked at it but needs more details.

  • CONFIRMED means that the bug can be reproduced (either by other users or the dev team)

  • ASSIGNED means that a developer is handling the bug

  • RESOLVED means that the bug was fixed in the development version

Step 5: Report the bug

If you have a crash at Kdenlive startup or when trying to play a video file, please follow these steps:

  • If you compiled Kdenlive and/or MLT yourself, make sure you followed all steps described in our instructions.

  • Check that you don’t have several versions of MLT installed

  • Try playing your video file with FFmpeg’s player. From a terminal: ffplay myvideo.mpg

  • Try playing your video file with MLT’s player. From a terminal: melt myvideo.mpg

Include the results in your bug report as attachments.

For a good bug report please include the following information:

  • Your Kdenlive and MLT version. You can copy that information from Kdenlive Menu ‣ Help ‣ About.

  • Your operating system (OS), like Windows, Linux distro, or MacOS including the respective version

  • The installation method for Kdenlive, like Windows installer or standalone, or Linux flatpak/snap/ppa or appimage

  • Detailed steps to reproduce the bug. Screenshots and screen recordings are very useful for replicating the issue.

  • Any error messages or log files you can provide. Please do not copy & paste log content into the bug report but add it as an attachment.

  • If the bug crashes Kdenlive, provide a backtrace.

How to get useful crash information (backtrace):

A backtrace contains valuable information for the dev team. It needs a bit of OS specific setup and command line wizardy and may therefore be not everyone’s cup of tea.

Linux appimage:

Please install the following packages: gdb, kdenlive-dbg, libmlt-dbg (package names may be slightly different depending on your distro)

When Kdenlive crashes, if the KDE crash handler dialog pops up, you can copy the data it provides. Otherwise, start Kdenlive from a terminal like this:

Type gdb kdenlive

After gdb read debug symbols, type run

Linux Flatpak:

First of all make sure the Flatpak debug symbols are installed by typing flatpak install org.kde.kdenlive.Debug to a command line.

Now you can start the Flatpak from a command line like this:

  • Start a shell inside the Kdenlive Flatpak sandbox: flatpak run --command=sh --devel org.kde.kdenlive

  • Type gdb /app/bin/kdenlive

  • After gdb read debug symbols, type run

For more details on Flatpak debugging see here: https://docs.flatpak.org/en/latest/debugging.html

Windows:

Build Kdenlive with KDE Craft locally as described here:

  • Type to the command line cd C:/CraftRoot/mingw64/bin

  • Start gdb with gdb

  • Start Kdenlive -> get the PID number

  • attach 3288 (replace 3288 by the PID number)

  • Wait on the (gdb) prompt

  • Type c

Once you followed the platform specific instructions above to start Kdenlive, you can trigger the bug. When Kdenlive crashes, go to your terminal window and type:

thread apply all bt full

Then press enter until you see the full data. Copy the log to a file and attach it to the bug report as an attachment.

Creating the Bug Report

Now that you have all the relevant and important information, it is time to file the bug report in the official KDE Bug Tracker, Bugzilla.

Open a browser and enter bugs.kde.org in the URI field.

kde_bugtracking_system.webp

KDE Bug Tracking System welcome screen

You may need to log on first or even create a user account. Please follow the onscreen instructions for that.

Click on File a Bug.

kde_bug_classification.webp

KDE Bug Tracking System classification selection

Click on Application to get to the list of all applications using Bugzilla.

kde_bug_application.webp

KDE Bug Tracking System application selection

The list is sorted alphabetically. Scroll down to where Kdenlive is listed, or use Ctrl+F to open a search field and enter kdenlive. This should work in most browsers but may be different in yours.

Bugzilla will open the detailed bug report screen where you can enter the bug report. Some fields are mandatory (indicated by the red *) and some will be populated with data collected from your system.

kde_bug_enter.webp

KDE Bug Tracking System entering bug details

1:

The bug report will be filed under your user name’s email address

2:

Select a component that best fits the type of problem you encountered

3:

Select the version of Kdenlive you are using

4:

Specify the severity of the problem. If you want to create a feature request, select wishlist.

5:

Select the platform you are using. This helps when troubleshooting.

6:

Select the operating system (OS) you are using

7:

Enter a short but descriptive summary if the bug or problem you are reporting

8:

This is where you describe the problem in more detail. The text between *** is for informational purpose only trying to prevent unnecessary bug reports. If you want to continue filing a bug report, please select this text and delete it. Then start entering your problem description.

Please be as detailed as possible describing what you did when the bug was triggered or Kdenlive did not work as expected.

There are a few sections prescribed already, like Step to Reproduce, Observed Results, and Expected Results that guide you through the bug report. It just helps structuring the report for easy reference and replication by the developer team.

In the section Software/OS Version you can paste the relevant data from Kdenlive Menu ‣ Help ‣ About Kdenlive ‣ Components ‣ Copy to Clipboard.

kde_bug_kdenlive_components

Copy information from Kdenlive

9:

You can add attachments like screen recordings, screenshots, and text files with debugging and terminal output information.

10:

Click Submit Bug to file your bug report