First steps to take before submitting a bug

From The Document Foundation Wiki
< QA
Jump to: navigation, search

The very first step: reproduce bug using latest fresh/still version

The two latest major releases, LibreOffice Fresh and LibreOffice Still (LibreOffice 5.4.1/LibreOffice 5.3.6) are both regularly updated with bug fixes. If your version is not the latest Fresh or Still release, the bug you are about to report might already be fixed. First update your LibreOffice installation, then check if the issue still persists.

You can also install a new version without disrupting the existing installation as described here: Installing in parallel.

NOTE: If the issue didn't go away, use the original version number in the bug report's Version field, which is for the earliest affected version.

Corrupted user profile

Symptoms:

  • Almost any kind of unusual behavior (especially if LibreOffice has been upgraded several times).

Steps to take:

  1. Locate your user profile.
  2. Rename or delete user profile.

For details see User profile location and Resolving corruption in the user profile (backing up the existing profile is highly advised).

NOTE: Corruption in the profile is notoriously hard to catch. Unless you are encountering this issue regularly, or you have specific steps to reproduce the issue, it isn't worth submitting a bug report. However, if you are uncertain, don't hesitate to submit one.

Graphics-related issues (OpenGL)

Symptoms:

  • Graphical glitches.
  • Crash.

Check if the following string appears in Help ▸ About LibreOffice: "UI Render: GL".

If there is "UI Render: default" instead, it means the symptoms aren't caused by OpenGL, and the rest isn't applicable.

Steps to take:

  1. Uncheck Tools ▸ Options... ▸ LibreOffice ▸ View ▸ Use OpenGL for all rendering (on restart).
  2. Restart LibreOffice.

If the issue is gone, locate <user profile>/cache/opengl_device.log, and attach it to the bug report. This will help the development team assess whether the issue could be with the OpenGL implementation in your system, or within LibreOffice.

Add your observations to the bug report.

Computation-related issues in Calc (OpenCL)

Symptoms:

  • Incorrect formula results.
  • Crash during calculation.

Steps to take:

  1. Uncheck Tools ▸ Options... ▸ LibreOffice ▸ OpenCL ▸ Allow use of OpenCL.
  2. Restart LibreOffice, check if issue still occurs.
  3. If it does, uncheck Tools ▸ Options... ▸ LibreOffice ▸ OpenCL ▸ Allow use of Software Interpreter (even when OpenCL is not available).
  4. Restart LibreOffice, check if issue still occurs.

If the issue is gone after step 2, locate <user profile>/cache/opencl_devices.log and opencl_profile.xml, and attach them to the bug report (these files are created since version 5.1.4). This will help the development team assess whether the issue could be with the OpenCL implementation in your system, or within LibreOffice.

Add your observations to the bug report.

NOTE: If the number of data cells used in formulas is small, OpenCL is not used even if enabled (OpenCL is used to speed up calculation on large datasets, and is usually not efficient on small amount of data). The lower limit is 100 by default, and can be adjusted in Tools ▸ Options... ▸ LibreOffice Calc ▸ Formula by selecting Custom (use OpenCL, conversion of text to numbers, and more), clicking Details, and adjusting Minimum data size for OpenCL use.