LibreOfficeBugWrangling
|
Size: 6447
Comment:
|
Size: 12118
Comment: 1) Due to LP#1506696 et. al. added sect. on AOO/OOo not supported. 2) chg'd wording stock > appropriate. 3) Unified responses.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## 20121122 https://launchpad.net/~penalvch When one files a bug via apport against libreoffice via ubuntu-bug libreoffice and did not install the libreoffice meta package, the filed bug report tends not to provide enough information to triage appropriately. Ex. https://bugs.launchpad.net/ubuntu/+source/libreoffice/+bug/1080509 one has no idea what specific LO packages they actually have installed. Hence, asking for apt-show-versions -r libreoffice* in the bug reporting template section is an extremely helpful way an original reporter can provide information for triagers to work on the problem without asking for follow up information, and waiting for the response. However, not all packages in https://launchpad.net/ubuntu/+source/libreoffice have libreoffice in the name, so some will be missed (ex. ure, python-uno, etc.). If a more comprehensive command exists to provide all the installed packages for libreoffice with versions compactly, that does not contain the word libreoffice in the package name, please replace. I just have not come across a more relevant one. Thank you for your understanding. Available languages: [[https://wiki.ubuntu.com/LibreOfficeBugWrangling_it| Italiano]] |
|
| Line 4: | Line 8: |
| = How to file = | = How to file a bug = |
| Line 6: | Line 10: |
| * Please file all your LibreOffice bugs by executing at the Terminal: <<BR>> {{{ubuntu-bug <PACKAGE>}}} <<BR>> <<BR>> where <PACKAGE> is the specific package you found the problem in. For example, if you have a document import issue with Writer: <<BR>> {{{ubuntu-bug libreoffice-writer}}} * Sample bug reporting template: <<BR>> ||<tablestyle="background-color: #eee"> 1) lsb_release -rd <<BR>> <<BR>> 2) apt-cache policy libreoffice-writer <<BR>> <<BR>> 3) What is expected to happen in Writer is <PRECISE, STEP-BY-STEP INSTRUCTIONS>. <<BR>> <<BR>> 4) What happened instead is... <<BR>> <<BR>> WORKAROUND: Perform the following steps:...|| |
* 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 uninstall all openoffice.org packages first, then install the full LibreOffice suite to avoid [[https://blueprints.launchpad.net/ubuntu/+spec/desktop-q-libreoffice-split|package split collatoral damage]], by executing at a terminal: ||<tablestyle="background-color: #eee"> {{{sudo apt-get -y install libreoffice}}}|| * Please file all your LibreOffice bugs by executing at the Terminal: <<BR>> {{{ubuntu-bug <PACKAGE>}}} <<BR>> <<BR>> where <PACKAGE> is the specific package you found the problem in. For example, if you have a document import issue with Writer: <<BR>> {{{ubuntu-bug libreoffice-writer}}} == Bug reporting template == ||<tablestyle="background-color: #eee"> 1) lsb_release -rd <<BR>> <<BR>> 2) apt-cache policy <PACKAGE> <<BR>> <<BR>> apt-show-versions -r libreoffice* <<BR>> <<BR>> 3) What is expected to happen in Writer is <PRECISE, STEP-BY-STEP INSTRUCTIONS>. <<BR>> <<BR>> 4) What happened instead is... <<BR>> <<BR>> I have the following extensions installed: lo-menubar... <<BR>> <<BR>> WORKAROUND: Perform the following steps:...|| /!\ 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 10: | Line 20: |
| * 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 relevent, 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. | * 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. |
| Line 12: | Line 22: |
| = Debugging procedure = == Document Issues == === 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. |
= Debugging = |
| Line 17: | Line 24: |
| === 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. |
== Move ~/.config/libreoffice == |
| Line 20: | Line 26: |
| === Bug exporting to PDF === * If you are reporting about how a document looks exporting to Evince, please attach the file to the bug report before and after exporting to PDF. As well, provide screenshots of how it looks in LibreOffice, Evince, and Adobe Reader. |
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. |
| Line 23: | Line 28: |
| == Printing == | == 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 == |
| Line 26: | Line 52: |
| == Crashes == * For instances when LibreOffice crashes, please ensure you have all the debug symbols installed (ex. libreoffice-dbg) and that it is reported via Apport. 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. |
== LibreOffice crashes but system still functional == |
| Line 29: | Line 54: |
| == Regressions == | * 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. * For suspected GUI/desktop environment driven crashes (ex. reproducible in Kubuntu but not Xubuntu), please uninstall the packages libreoffice-gtk, libreoffice-gnome, libreoffice-gtk3, and libreoffice-kde and comment on if this changes anything. == 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 == |
| Line 31: | Line 67: |
== 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). |
|
| Line 38: | Line 71: |
| Line 40: | Line 74: |
| == 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 upstreams rapid maintenance cadence. <<BR>> A Won't Fix Wishlist stock reply: |
== Wishlist reports == |
| Line 43: | Line 76: |
| ||<tablestyle="background-color: #eee">Thank you for reporting this and helping making Ubuntu better. Regarding this report:<<BR>>- This is a clearcut upstream issue. Your 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.<<BR>>- 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.|| | * 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>> An appropriate [[https://wiki.ubuntu.com/Bugs/Bug%20statuses|Won't Fix]] [[https://wiki.ubuntu.com/Bugs/Bug%20importances|Wishlist]] reply: |
| Line 45: | Line 80: |
| == How to Forward bugs upstream == * Once marked Traiged, a report may be filed upstream at the Freedesktop.org Bugzilla for product = "LibreOffice" or click on https://bugs.freedesktop.org/enter_bug.cgi?product=LibreOffice to jump directly. |
||<tablestyle="background-color: #eee">Thank you for reporting this and helping making Ubuntu better. Regarding this report:<<BR>>- 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.<<BR>>- 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. <<BR>><<BR>> Thank you for your understanding.|| == Apache OpenOffice / OpenOffice.org bugs == The Ubuntu project no longer supports Apache OpenOffice (AOO) / OpenOffice.org (OOo), in favor of LibreOffice. This is an important distinction for original reporters of AOO/OOo bugs, as AOO/OOo 4.1.1 was released on August 21, 2014, and just the announcement of the next version (4.1.2) coming soon didn't come out until September 27, 2015 (over a year). This indicates a long lag in security and bug fixes, in comparison to LibreOffice's fast, and timely maintenance cadence as noted [[https://wiki.documentfoundation.org/ReleasePlan|here]]. Hence, an appropriate triaging response is: ||<tablestyle="background-color: #eee"> Thank you for reporting this and helping make Ubuntu. <<BR>> <<BR>> However, there are no new official Apache OpenOffice/OpenOffice.org releases in Ubuntu, as the Ubuntu project has transitioned to LibreOffice. Hence, the status of this report is being marked as Won't Fix. <<BR>><<BR>> You are welcome to test for this problem in LibreOffice. If reproducible, please click the button: <<BR>> Also affects distribution <<BR>><<BR>> Distribution: Ubuntu <<BR>> Source Package Name: (Optional) libreoffice <<BR>><<BR>> For more on installing LibreOffice please see [[https://wiki.ubuntu.com/LibreOffice]]. <<BR>><<BR>> Thank you for your understanding.|| == 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
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 uninstall all openoffice.org packages first, then 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 |
![Warning /!\](/moin_static198/light/img/icon_eek.png "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
For issues printing from LibreOffice please report this against cups first via the Terminal:
ubuntu-bug cups
It could end up being an issue with LibreOffice, but it's best to start with cups in order to rule it out. As well, please follow all steps noted in https://wiki.ubuntu.com/DebuggingPrintingProblems .
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.
- For suspected GUI/desktop environment driven crashes (ex. reproducible in Kubuntu but not Xubuntu), please uninstall the packages libreoffice-gtk, libreoffice-gnome, libreoffice-gtk3, and libreoffice-kde and comment on if this changes anything.
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
For regressions, it is helpful to perform a binary bisect ("bibisect") to narrow down which commit specifically caused the problem. For instructions please see http://sweetshark.livejournal.com/7683.html .
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.
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.
An appropriate Won't Fix Wishlist reply:
Thank you for reporting this and helping making Ubuntu better. Regarding this report: |
Apache OpenOffice / OpenOffice.org bugs
The Ubuntu project no longer supports Apache OpenOffice (AOO) / OpenOffice.org (OOo), in favor of LibreOffice. This is an important distinction for original reporters of AOO/OOo bugs, as AOO/OOo 4.1.1 was released on August 21, 2014, and just the announcement of the next version (4.1.2) coming soon didn't come out until September 27, 2015 (over a year). This indicates a long lag in security and bug fixes, in comparison to LibreOffice's fast, and timely maintenance cadence as noted here.
Hence, an appropriate triaging response is:
Thank you for reporting this and helping make Ubuntu. |
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
Or in the old fashioned way at https://bugs.freedesktop.org/enter_bug.cgi?product=LibreOffice (1)
LibreOfficeBugWrangling (last edited 2018-06-04 22:50:25 by penalvch)