LibreOfficeBugWrangling

Differences between revisions 21 and 23 (spanning 2 versions)
Revision 21 as of 2014-02-23 16:11:30
Size: 10478
Editor: penalvch
Comment: RM'ed "Failure to..." as already noted previously.
Revision 23 as of 2014-02-23 18:57:26
Size: 10402
Editor: penalvch
Comment: Streamlined article: 1) RM'ed duplicate section. 2) Collected Debug/Trouble into Debug. 3) Misc. minor rewords.
Deletions are marked like this. Additions are marked like this.
Line 8: Line 8:
= How to File = = How to file a bug =
Line 10: Line 10:
 * Please do not report a LibreOffice bug without first reading this wiki article and performing all the relevant actions mentioned here.  * Please do not report a LibreOffice bug without first reading this wiki article and performing all the relevant actions mentioned here. Failure to do so may delay your bug getting addressed as quickly as possible.
Line 15: Line 15:
== Bug Reporting Template == == Bug reporting template ==
Line 18: Line 18:
 /!\ Please note the above 1) and 2) are terminal commands to execute, and post the results of when initially filing your bug report. Failure to follow this format will delay in your bug getting addressed as soon as possible. As well, you may need to install the package [[https://launchpad.net/ubuntu/+source/apt-show-versions|apt-show-versions]].  /!\ Please note the above 1) and 2) are terminal commands to execute, and post the results of when initially filing your bug report. As well, you may need to install the package [[https://launchpad.net/ubuntu/+source/apt-show-versions|apt-show-versions]].
Line 22: Line 22:
= Debugging Procedure =
== Document Issues ==
= Debugging =
Line 25: Line 24:
=== Bug importing a non-MS Office document === == Move ~/.config/libreoffice ==
Try moving .libreoffice and ~/.config/libreoffice. If you installed any extensions, remove them and see if the problem is reproducible. Comment on the results of performing these techniques in your report. Please keep these directories around -- if moving the profile helps you, developers might be interested in it to find out what was wrong with it.

== Bug importing a non-MS Office document ==
Line 28: Line 30:
=== Bug exporting to MS Office === == Bug exporting to MS Office ==
Line 31: Line 33:
=== Bug Importing from MS Office === == Bug importing from MS Office ==
Line 34: Line 36:
=== Bug Exporting to Adobe PDF === == Bug exporting PDF to Adobe ==
Line 37: Line 39:
=== Bug Importing PDF === == Bug importing PDF ==
Line 40: Line 42:
== Printing == = Printing problems ==
Line 43: Line 45:
== Crashes ==
=== LibreOffice Crashes but System Still Functional ===
* For instances when only LibreOffice crashes but you can still use the OS without hard rebooting, please report this via Apport and ensure you have all the LibreOffice debug symbols installed (libreoffice-dbg, uno-libs3-dbg, and ure-dbg). For more on this please see https://wiki.ubuntu.com/Apport . As well, if this happened while a particular document was open or you were manipulating the document, please attach that document to the bug report with detailed, click-for-click steps on how to reproduce the crash.
 * In the rare instance that after you followed the above, apport did not kick in, please provide a backtrace, valgrind, and strace following https://wiki.ubuntu.com/DebuggingProgramCrash .
== LibreOffice crashes but system still functional ==
 * For instances when only LibreOffice crashes but you can still use the OS without hard rebooting:
  * Please consult
https://wiki.ubuntu.com/Apport to ensure Apport is enabled.
  * Please make sure LibreOffice debug symbols are installed (libreoffice-dbg
, uno-libs3-dbg, and ure-dbg).
  * I
f this happened while a particular document was open or you were manipulating the document in a certain way, please attach that document to the bug report with detailed, click-for-click steps on how to reproduce the crash.
Line 48: Line 51:
=== The Whole System Hangs or Boots to the Login Screen ===
 * For instances when you are using LibreOffice and either the system hangs requiring a hard reset or you are booted to the login screen, this is a bug in either xorg or the kernel. Please follow https://help.ubuntu.com/community/DebuggingSystemCrash . As well, if this happened while a particular document was open or you were manipulating the document, please attach that document to the bug report with detailed, click-for-click steps on how to reproduce the crash.
== The Whole system hangs or boots to the login screen ==
 * For instances when you are using LibreOffice and either the system hangs requiring a hard reset or you are booted to the login screen, this is a bug in either xorg or the linux kernel. Please follow https://help.ubuntu.com/community/DebuggingSystemCrash . As well, if this happened while a particular document was open or you were manipulating the document, please attach that document to the bug report with detailed, click-for-click steps on how to reproduce the crash.
Line 51: Line 54:
=== Troubleshooting Techniques ===
Try moving .libreoffice and ~/.config/libreoffice. If you installed any extensions, remove them and see if the problem is reproducible. Comment on the results of performing these techniques in your report. Please keep these directories around -- if moving the profile helps you, developers might be interested in it to find out what was wrong with it.

== Regressions ==
== Bibisecting regressions ==
Line 57: Line 57:
== Wishlists ==
 * For Wishlist reports, many of these are requests to implement a feature in LibreOffice found in MS Office. A broad but good rule of thumb is if you want LibreOffice to do something that MS Office does (MS Office compatibility expectation), please document how specifically MS Office does it, then how LibreOffice does not or does not do well that which you desire. Please keep in mind, pocket cases exist where LibreOffice intentionally does not do what MS Office does (ex. leap year implementation https://bugs.launchpad.net/ubuntu/+source/libreoffice/+bug/456100).

= Triaging LibreOffice Bugs =
= Triaging LibreOffice bugs =
Line 65: Line 62:
== Wishlist Reports ==
 * For Wishlist reports, they most likely should be marked Won't Fix Wishlist. This is due to how Ubuntu diverts very little from the LibreOffice upstream source release, and upstream's rapid maintenance cadence. <<BR>> A Won't Fix Wishlist stock reply:
== Wishlist reports ==
 * For Wishlist reports, these typically are requests to implement a new feature in LibreOffice not currently supported. A broad but good rule of thumb is if you want LibreOffice to do something that MS Office does, as LibreOffice intends compatibility with MS Office, please document how specifically MS Office does it, then how LibreOffice does not or does not do well that which you desire.
  * Please keep in mind, pocket cases exist where LibreOffice intentionally does not do what MS Office does (ex. leap year implementation https://bugs.launchpad.net/ubuntu/+source/libreoffice/+bug/456100).
 * For Wishlist reports, they would typically be marked Won't Fix Wishlist. This is due to how Ubuntu diverts very little from the LibreOffice upstream source release, and upstream's rapid maintenance cadence. <<BR>> A [[https://wiki.ubuntu.com/Bugs/Bug%20statuses|Won't Fix]] [[https://wiki.ubuntu.com/Bugs/Bug%20importances|Wishlist]] stock reply:
Line 70: Line 69:
== How to Forward Bugs Upstream ==
 * Once marked Triaged, a report may be filed upstream using the [[https://www.libreoffice.org/get-help/bug/|LibreOffice Bug Submission Assistant]] <<FootNote(Or in the old fashioned way at https://bugs.freedesktop.org/enter_bug.cgi?product=LibreOffice)>>.
== How to forward bugs Upstream ==
 * Once marked Triaged, a bug that is reproducible in the upstream release would want to be filed upstream using the [[https://www.libreoffice.org/get-help/bug/|LibreOffice Bug Submission Assistant]] <<FootNote(Or in the old fashioned way at https://bugs.freedesktop.org/enter_bug.cgi?product=LibreOffice)>>.

Available languages: Italiano

Debugging Central

This page is part of the debugging series — pages with debugging details for a variety of Ubuntu packages.

How to file a bug

  • Please do not report a LibreOffice bug without first reading this wiki article and performing all the relevant actions mentioned here. Failure to do so may delay your bug getting addressed as quickly as possible.

  • First, before filing a bug report, please make sure you install the full LibreOffice suite to avoid package split collatoral damage, by executing at a terminal:

sudo apt-get -y install libreoffice

  • Please file all your LibreOffice bugs by executing at the Terminal:
    ubuntu-bug <PACKAGE>

    where <PACKAGE> is the specific package you found the problem in. For example, if you have a document import issue with Writer:
    ubuntu-bug libreoffice-writer

Bug reporting template

1) lsb_release -rd

2) apt-cache policy <PACKAGE>

apt-show-versions -r libreoffice*

3) What is expected to happen in Writer is <PRECISE, STEP-BY-STEP INSTRUCTIONS>.

4) What happened instead is...

I have the following extensions installed: lo-menubar...

WORKAROUND: Perform the following steps:...

  • Warning /!\ Please note the above 1) and 2) are terminal commands to execute, and post the results of when initially filing your bug report. As well, you may need to install the package apt-show-versions.

  • Please do not stack multiple issues into one bug.
  • Please do not complain about how long it takes to fix a bug, the severity of your bug is high so it should be fixed immediately, "I cannot believe it's not fixed...", etc. Especially, if you have not completed the relevant, below mentioned debugging procedures, let alone contributed code upstream. This type of behavior is unconstructive, irritating to others who read your E-Mail, and spammy. We all want to see every bug fixed as soon as possible! Naturally, bugs being fixed is limited to reproducibility and clarity of the bug report, the actual impact the bug has on the community, and available developer resources.

Debugging

Move ~/.config/libreoffice

Try moving .libreoffice and ~/.config/libreoffice. If you installed any extensions, remove them and see if the problem is reproducible. Comment on the results of performing these techniques in your report. Please keep these directories around -- if moving the profile helps you, developers might be interested in it to find out what was wrong with it.

Bug importing a non-MS Office document

  • If you are reporting about importing a non-MS Office document, please attach the document to the bug report before opening in LibreOffice or in any other program. As well, please post a screenshot of how it looks in LibreOffice with a specific description about how it should look.

Bug exporting to MS Office

  • If you are reporting about how a document looks different exporting to MS Office, please attach the document to the bug report immediately after saving via LibreOffice, but before opening in MS Office. As well, please post a screenshot of how it looks in LibreOffice and then how it shows in MS Office.

Bug importing from MS Office

  • If you are reporting about how a document looks importing from MS Office, please save the file in MS Office, then before opening in any other program, attach the document to the bug report. As well, please post a screenshot of how it looks in LibreOffice and then how it shows in MS Office.

Bug exporting PDF to Adobe

  • If you are reporting about how a document looks exporting to Adobe Reader, please attach the file to the bug report before and after exporting to PDF. As well, provide screenshots of how it looks in LibreOffice and Adobe Reader.

Bug importing PDF

  • If you are reporting about how a PDF document looks importing into Draw, please attach the file to the bug report before importing into Draw. As well, provide screenshots of how it looks in LibreOffice and Adobe Reader.

= Printing problems ==

LibreOffice crashes but system still functional

  • For instances when only LibreOffice crashes but you can still use the OS without hard rebooting:

    • Please consult https://wiki.ubuntu.com/Apport to ensure Apport is enabled.

    • Please make sure LibreOffice debug symbols are installed (libreoffice-dbg, uno-libs3-dbg, and ure-dbg).

    • If this happened while a particular document was open or you were manipulating the document in a certain way, please attach that document to the bug report with detailed, click-for-click steps on how to reproduce the crash.

The Whole system hangs or boots to the login screen

  • For instances when you are using LibreOffice and either the system hangs requiring a hard reset or you are booted to the login screen, this is a bug in either xorg or the linux kernel. Please follow https://help.ubuntu.com/community/DebuggingSystemCrash . As well, if this happened while a particular document was open or you were manipulating the document, please attach that document to the bug report with detailed, click-for-click steps on how to reproduce the crash.

Bibisecting regressions

Triaging LibreOffice bugs

Writer and Calc

  • For bugs in Writer, it is helpful to check to see if the problem exists in AbiWord. For bugs in Calc, it is helpful to check to see if the problem exists in Gnumeric. Sometimes, AbiWord and Gnumeric give the bug reporter a usable workaround to the problem (and vice versa). If a workaround is found, feel free to document it in the report. As well, while not quite apples and oranges code wise, it gives LibreOffice developers code to base a patch on.

Wishlist reports

  • For Wishlist reports, these typically are requests to implement a new feature in LibreOffice not currently supported. A broad but good rule of thumb is if you want LibreOffice to do something that MS Office does, as LibreOffice intends compatibility with MS Office, please document how specifically MS Office does it, then how LibreOffice does not or does not do well that which you desire.

  • For Wishlist reports, they would typically be marked Won't Fix Wishlist. This is due to how Ubuntu diverts very little from the LibreOffice upstream source release, and upstream's rapid maintenance cadence.
    A Won't Fix Wishlist stock reply:

Thank you for reporting this and helping making Ubuntu better. Regarding this report:
- This is a clearcut upstream issue. You are welcome to send this to the developers of the software by following the instructions at http://wiki.documentfoundation.org/BugReport . If you have done so, please tell us the number of the upstream bug (or the link), so we can add a bugwatch that will inform us about its status.
- Marking LibreOffice Packaging and libreoffice (Ubuntu) => Won't Fix Wishlist. This does not mean the issue will not be cared about, but if it is cared about (even by Ubuntu/Canonical contributors), it is done upstream at LibreOffice.

How to forward bugs Upstream

  • Once marked Triaged, a bug that is reproducible in the upstream release would want to be filed upstream using the LibreOffice Bug Submission Assistant 1.

    • Once a remote bug watch has been added to a bug report, it is helpful to append [Upstream] to the beginning of the bug title. This helps in searching for bugs reports by title. Please do not append this unless a remote bug watch has been added to the report as this creates confusion on which bugs have been reported upstream and which have not.


CategoryBugSquad CategoryDebugging

LibreOfficeBugWrangling (last edited 2018-06-04 22:50:25 by penalvch)