Bug reporting

From Pitivi wiki
Jump to: navigation, search

Welcome, testers! Bug reporting and feature requests are done using GNOME's Bugzilla interface. You will need a bugzilla account to file bugs and comment on them. See the "Example queries" section at the end of this page for some useful links for searching Pitivi's bug list.

Attention! There are some known performance problems in some of our older releases.
See also our troubleshooting page.

Remember to take a look at the existing list of bugs/feature requests to see if your problem has already been reported (hint: use the control+F functionality of your browser!).


Example queries

Special searches

Providing debugging information

Sharing sample files (and "scenarios") for testing

In some cases we might ask you to share sample media files with us to debug a particular issue. If you don't have your own hosting space, we have a FTP account with unlimited space available for this purpose, provided by idmark.ca.

In addition to samples, it is extremely helpful to provide "scenario" files. These are files that are automatically generated each time you use a project. Combined with your project files, those can allow us to reproduce exactly the actions that have occurred to trigger the bug. This makes triggering the issue on our machines a very easy and reliable process, which saves you a ton of time! Here's how to provide scenario files to facilitate the process:

  1. Use the “Select unused clips” feature to easily remove unused media from your project, this will help you save space (and upload time).
  2. Save your project, right before triggering the bug.
  3. Trigger the bug (make Pitivi crash or freeze)
  4. Get the last/newest scenario file from ~/.cache/pitivi/scenarios/
  5. Reopen your project, and use the “Export project as tarball...” menu item in the hamburger menu. Save the .xges_tar file somewhere. It will contain your project file and its associated media.
  6. Temporarily rename the .xges_tar to .tar, add the scenario file to the tarball, then you can rename it to .xges_tar again and upload it for us to reproduce your issue and integrate it into our test suite so that it does not happen again in the future!

Stack traces for crashes

When reporting a crash, it would be good to provide a stack trace. See GNOME's Getting Traces instructions for some comprehensive documentation and tips on the subject.

For those of you who already know how to install the relevant debug packages etc, we provide you with some simple reminders below of commands that can be particularly useful in Pitivi's context.

When you want to "attach" to an existing Python process (useful for deadlocks, where the application will be hung instead of crashed):


When you want to run Pitivi entirely in gdb from the start:

gdb python3
set pagination 0  # avoids the need to press Enter to "scroll"

run /usr/bin/pitivi  # the version installed system-wide.
run bin/pitivi  # the development version from inside the build tree.

And then, you can either use "bt full" or "thread apply all bt" to get the backtrace.

Debug logs

When you need to know what’s going on inside pitivi, you can launch it with a debug level. In loggable.py, there are five levels: ( ERROR, WARN, FIXME, INFO, DEBUG, LOG ) = range(1, 7). As such, if you want to see errors and warnings only, you launch

PITIVI_DEBUG=2 bin/pitivi

...and if you want to see everything you do

PITIVI_DEBUG=6 bin/pitivi

If that's "too much" and you want to focus on particular parts of the code, you can do so. For example, you can get output from the "Timeline" and "MediaLibraryWidget" classes only:

PITIVI_DEBUG=timeline:6,medialibrarywidget:6 bin/pitivi

Here are various examples of commands you can use to generate detailed debug logs that include not only Pitivi's debug output, but also GStreamer's:

A basic log can be obtained by running:

PITIVI_DEBUG=*:5 GST_DEBUG=2 bin/pitivi > debug.log 2>&1

To get debugging information from GNonlin, you could use:

PITIVI_DEBUG=5 GST_DEBUG=3,gnl*:5,python:5 bin/pitivi > debug.log 2>&1

The information most likely to be useful would probably be the debug info from GES in addition to Pitivi's:

PITIVI_DEBUG=5 GST_DEBUG=ges:5 bin/pitivi > debug.log 2>&1;

Some additional tips:

Personal tools