QA/Bibisect

From The Document Foundation Wiki
< QA(Redirected from QA/HowToBibisect)
Jump to: navigation, search
Other languages:
dansk • ‎English • ‎日本語 • ‎русский • ‎中文(简体)‎

Introduction

Bibisect stands for "binary bisect". It's a procedure that helps identify commits that have caused regressions. Regressions are a most annoying artifact that unfortunately come with software development and QA. We want to deal with regressions quickly before time passes and they get harder and harder to triage and fix.

How does Bibisecting Work?

Each bibisect package is a git repository populated with hundreds or thousands of builds of LibreOffice. Added to the repository in chronological order, the builds provide a fast and simple way for us to test a bug against many different versions without having to compile LibreOffice each time we switch to a different version.

We can leverage the tools built into git for binary search through commits (e.g. git bisect) as well as benefit from the compression and de-duplication functions included in git. For example, in a series of builds that each might take up 500MB of disk space, through de-duplication we can potentially use only 25MB per additional build.

Watch Effective Bisection and Bibisection (Matthew Francis's talk at LibOCon 2015 on YouTube) for both an introduction, and practical details.

Details

A successful bibisect will leave developers with only a few commits to search through to find the 'culprit' commit that we believe introduced a regression. QA can go the additional step of fully bisecting (determining the exact commit) or can leave this to the developers. It's often easy to find the commit that caused the issue after bibisecting the bug.

With approximately 10 gigs, you'll have hundreds of builds to work with. A bibisect can take as little as 15 minutes.

Currently, bibisecting is possible on:

As can be seen from the Commits in range and Number of builds, depending upon the particular bibisect repository, this range might be on average 80 commits for old "43max" repository (reaching hundreds of source commits in some builds) to just 1 or 2 commits for newer repositories. (We also have some very 'coarse' bibisect repositories that use released versions + beta + RC builds, and these may have ranges spanning multiple hundreds of commits).

If build commit or range is found, bug is marked with keyword "bibisected", and if source commit is found, bug is additionally marked "bisected".

General Instructions

It might be a good idea for beginners to start by tracing the steps of a bibisect that was already completed successfully. For this purpose we have a bibisecting tutorial.

Note: Each operating system is different, please read the full instructions that correspond to your specific operating system (GNU/Linux, macOS, or Windows) for more complete instructions, instructional videos, and other related information.

Bibisecting relies on 6 steps:

  1. Setting up your environment, including installing any extra software
  2. Downloading the bibisect package
  3. Bibisecting the bug
  4. Getting a bibisect log
  5. Attaching the bibisect log to the bug report
  6. Remove keyword 'bibisectRequest' from Keywords field and add the keyword 'bibisected'
  7. If the commit causing the regression has been identified, also add the keyword 'bisected', add the developer as CC and add the comment 'Adding Cc: to <developer's name>'

Note that you should only add the original committer to the CC, not any reviewers. If a developer has retired from the project (check the date of their last commits), there is no point in adding anyone to the CC. Rather in this case, you should bump the priority of the bug report.

Some bibisect repositories have ranges of source commits folded into a single chunk. If after completing a bibisect you are presented with only a single one of these chunk commits, you can get the range by first copying the hash (note: not the source hash) and using it in a git log command like so:

git log c3f9dc54188b316a61dd871b63734d49b05f5d7f

Now you can copy the source hashes of the first and previous displayed commits and use them to construct a range query like so: https://git.libreoffice.org/core/log/7c4d3ea6ba4d42b4dda5148a00c8c411b5d7703d..5b195fbcf7a441aeb193f6abd08b877e580938e0 This will allow you to skim commit messages looking for related subjects. For deeper scrutiny, see the section on detective work.

Limitations

Performing a bibisect is only possible if we have a repository available for the correct OS, covering the correct range of LibreOffice commits. We have very good coverage on GNU/Linux, and are improving our coverage on Windows and macOS.

Some regressions are difficult to reproduce, and may require multiple test runs for a bug to appear. As you may imagine, trying to bibisect such regressions is very difficult, and requires one to perform many test runs after each checkout of a new version of LibreOffice to give some security / statistics that the bug is indeed present or not present with the given version.

We do not currently have bibisect support for

Versions

Versions are listed on each OS page. See #Details above.

Not Bibisectable

Some bugs are not bibisectable. These include

  • Bugs that don't show up on a supported platform (see #Limitations)
  • Bugs that predate our bibisect builds (We're working on extending the range covered)
  • Bugs that depend upon build options not enabled in the TDF builds (e.g. -kde)

If a bug with bibisectRequest Keyword is found to be not bibisectable, leave a comment on the bug explaining why we're not able to use bibisect to track down the introduction of this problem, and replace Keyword bibisectRequest with notBibisectable.

Finding bugs

Finding bugs needing bibisect

Following Bugs with Keyword bibisectRequest are waiting for a bibisect:

Full Query
ID Summary Priority Status
56894 FORMATTING: Cell borders drawn using (python) scripts do not draw as expected in all cases medium NEW
62093 VIEWING of preview in Print Dialog destroyed after horizontal or vertical resize medium NEW
69017 FILEOPEN: text rendering (font replacement for UniversR 45 Light) in some cells too wide (new lines, changing row height, an extra page) medium NEW
70633 Writer EDITING: Unable to use AltGr to produce supplementary plane chars medium NEW
70676 PRINTING: Difficulties with combining smaller pages on a bigger one medium NEW
75218 Letter Wizard does not respect locale anymore medium NEW
79452 Themes with a separator line per toolbar incorrectly places separator line at bottom when toolbar docked at bottom low NEW
83159 DATALOSS: default font size not saved in chart textbox medium NEW
87058 column label functions do not update after inserting rows below title - needs save and reload including a hard recalc medium NEW
88066 UI status line insert/overwrite mode display broken medium NEW
91237 CALC hangs on web table paste (intermittent) high NEW
91418 AGAIN! All text and graphics disappeared after saving and closing document. high NEW
92433 Writer hangs and eats a lot of memory until being killed while processing complex 134-page DOCX with images medium NEW
92880 CopyFromRecordset function not working since 4.x medium NEW
92909 UI - Table creation field data types are displayed in rounded buttons that do not fill grid cell (OSX only) low NEW
93890 FILEOPEN clean-up of bookmark-start and -end breaks references medium NEW
94113 Accessible focus event missing when caret moves to start of paragraph spanning two pages (see comment 11) medium NEW
95191 Forms and dialogs opened via macros on ODB file open no longer work high NEW
96176 DRAW: Slow performance zooming an SVG after opening medium NEW
96310 LO will hang for 30 plus seconds after opening EMR software alongside the LO suite (1 processor fully consumed) medium NEW
96341 Version 5.1 takes a lot more RAM than version 5.0 in Windows medium NEW
97616 Calc conditional formatting: fast scrolling down and up shows borders that shouldn't be there low NEW
97790 [pyuno] unavailable exported functions and attributes medium NEW
98491 Split hsqldb Base application will not start under OSX10.11.x causes LO to freeze requiring force kill high NEW
98675 Missing possibility to print style definitions medium NEW
98743 TIFF EXPORT saves weird image: in different x-y resolution and dimensions medium NEW
100961 After inserting Fixed Date, and saving in DOC format, the date is not fixed anymore medium NEW
101376 Wordcount Beanshell macro execution causes deadlock / hang requiring forced kill high NEW
101379 UI - (on high resolution screens) text cursor is too thin and so nearly invisible medium NEW
101396 VIEWING Font color changes when auto spellcheck is enabled and text is underlined due to spelling error (steps in comment 7) medium NEW
103375 MAILMERGE: unpredictable failures: sometimes looses embedded image, or not all mails sent, when e-mailing as pdf medium NEW
103570 Java not selected automatically when a database is opened for the first time low NEW
104037 Writer: embedded Starview Metafile file results in slow scrolling medium NEW
104563 Writer doesn't allow to resize window to less than 4/5 of full screen in height medium NEW
105588 SVG exported from Impress or Draw cannot be correctly inserted as an image into another document medium NEW
105690 FILESAVE: Button dissapears after saving in Calc medium NEW
106484 UI: Print Properties Device tab dropdown items not applied or remembered medium NEW
106831 Can't print #10 envelopes properly and with proper orientation medium NEW
106981 The Repeat feature when you select an Inserted Video for it to play in a Loop during a slideshow no longer works (64-bit only) medium NEW
107443 FILEOPEN: "Open" in "Document in Use" dialog for non-default file format documents opens read-only medium NEW
107987 EDITING: Resizing an image is slow depending on slide design medium NEW
108232 Marco Flotante (floating frame) can not be modified, deleted or modified after inserting medium NEW
108244 Cell Comments Often Loss when Saving in FODS Format. Steps to reproduce in comment 5 medium NEW
108560 Editing multi-line cells with thousands of words is slow when OpenGL is enabled medium NEW
109004 External form does not save the path to database any more. medium NEW
109090 Lang pref English (USA) shows as French (France) in spell checker dialogue high NEW
111461 XLSX with 0px height or 0px width images hangs LO and produce a lot of temp files medium NEW
111674 Always office:value="0" for field variable "Formula", which is <text:expression> in file format high NEW
112811 FILESAVE: DOCX - Dots separator in index not fully preserved medium NEW
113273 Crash in: SfxShell::SetDisableFlags(SfxDisableFlags) medium NEW
113673 Filter WMF: fix for WMF images is not adopted by Slide Show mode (LO 6 Alpha 1 only) medium NEW
114272 [macOS] Some Asian characters are garbled with western fonts. medium NEW
114602 Query-Editor: No functions available for Sqlite 3 odbc high NEW
115077 Merge mail wizard send empty images by mail in HTML format medium NEW
116047 LO 6.0.1.1 (x64) calc windows, autofilter freezes medium NEW
116547 Export of mathematical formula in Writer document to DOCX is displayed incorrectly in Word medium NEW
117255 EDITING: Star Obj Descr (XML) Resize preview is sometimes inconsistent medium NEW
117818 CHAPTER NUMBERING DIALOG: Preview doesn't work as expected (steps in comment 1) medium NEW
117905 Coinmarketcap api doesn't work anymore medium NEW
118024 cursor stops moving up under certain conditions medium NEW
118603 Temporarily huge memory usage bump when saving a copy of a file (containing HI-res images); release is delayed medium NEW
118673 Cross reference category disappears when a comment is placed in the caption category medium NEW
118675 Low image quality when using special paste bitmap of a shape/textbox medium NEW
118748 Accessibility events missing when Calc cells become unselected due to navigating to focused cell medium NEW
119081 RTF paste not working when attempting to paste under an embedded table medium NEW
119139 Mysql timestamp fields not displayed in table data entry mode with mysql jdbc-connector ConnectorJ 8.x high NEW
119286 Sanitize documents using "Find & Replace" getting slower and slower medium NEW
119329 Variable in equation in .docx vanishes if we open the file in Writer (Win10 only?) medium NEW
119366 FREEZING with long and complex documents medium NEW
119520 The table borders/content shifting when saving with selected content (and afterwards when deselecting) medium NEW
119724 MacOS: Large delay before the red spell checker lines show up after pasting the same content multiple times. Lots of time spend in Scheduler::ProcessTaskScheduling() medium NEW
120014 MacOS: Lots of unresponsiveness (beachballs) when enabling automatic spell checking in a large document high NEW
120154 High RAM usage ( around 300mb for 10 mins and drop to 150-200 mb) medium NEW
120216 Table make Impress slow and dump medium NEW
120358 Long multi-layered numbered list in a table became mis-ordered after some editing medium NEW
120360 Draw extremely slow when table is added medium NEW
120440 Memory usage is increasing rather fast when creating lots of empty documents (45) and pasting a plain text in it medium NEW
120539 Position of adjusted middle line on connectors is randomly changed when copying the drawing to a writer document medium NEW
120646 Handling of columns in section not correct medium NEW
120796 Attempting to open a ".txt" file with Calc selected from Windows explorer "Open with", opens Writer instead medium NEW
121092 Libreoffice 6.1.3.2 does not allow saving Advanced Properties options with SQLITE 3 over ODBC medium NEEDINFO
121698 Saving a document with thousands of comments hangs (GTK3) high NEW
121847 IMPRESS: slide marking on side pane lost when switching to notes view medium NEW
121860 System slows down (freezes) while marking/selecting a lot of single cells by Ctrl+Left Mouse Click medium NEW
121996 Crash in: rtl_uStringbuffer_remove when EDITING grid control high NEEDINFO
122206 FILEOPEN: Opening XML file with XSLT filter opens with plain text import dialogue medium NEW
122274 Annotating slide with INK using PEN cursor mode during edit session of file makes INK permanent medium NEW
122298 Charts in Base-Forms couldn't be changed by macro any more medium NEW
122419 AutoFilter Search Freezes Calc in the Attached Spreadsheet medium NEW
122585 Classification: by using the dialog, footer text from policy is not placed in the document - it is the same as the header medium NEW
122586 Classification: by using the dialog, Watermark text from policy is not placed in the document medium NEEDINFO
122779 FILEOPEN (BASE) Connection to Oracle DB via ODBC ends in [ODBC][ORACLE] Optional Feature not implemented medium NEEDINFO
122905 FORM - Tablecontrol: Second listbox won't show right content when directly beneath first listbox high NEW
122952 Writer typing lag when editing text while header image is showing on screen medium NEW
122968 Stuttering/ judder while scrolling using page down (pages per second rate has worsened) medium NEW
123070 EDITING: Moving fields in Query designer GUI isn't shown with an arrow any more medium NEW
123167 BASIC: Pictures in buttons are not persistent in a dialog medium NEW
123234 Missing characters while exporting to PDF using certain fonts (IM fell from arch user repository) medium NEW
123418 Showing all comments takes longer compared with 4.4.7.2 medium NEW
123419 Scrolling around in a document with lots of comment shown very slow compared to 4.4.7.2 medium NEW
123466 Suspicious Log Messages about String comparison medium NEW
123555 Table of Content link tooltip renders blank squares instead of Chinese characters in Word openxml document high NEW
123633 Web view and hide whitespace causes view position to jitter until entire document is reformatted medium NEW
123700 Adding selection mode is unreliable, clearing selections instead of adding medium NEW
123844 Groupedbar compact almost empty on MacOS high NEW
124000 FILEOPEN DOCX Last row of OLE object table is missing because rows taller in LO medium NEW
124104 LibreOffice Base: Text cut off in GUI elements with font scaling enabling or when font size increased above 12 point medium NEW
124213 A recovered document has "(Remote)" in the title medium NEW
124214 Fuzzy rendering of a FontWork after some stressing medium NEW
124409 Opening the WriterGuideLO.odt manual is slower in 6.3 compared to 4.4.7.2 medium NEW
124569 Undoing a deletion of text with fieldmarks moves the closing fieldmark 2 chars right medium NEW
124587 Character highlighting going over text in other lines in slideshow mode medium NEW
124795 Scrolling: Writer 100% CPU on specific docx (with table structure) medium REOPENED
124852 Heading characters much too big when copy-paste as GDI metafile medium NEW
125057 [FORMATTING] Conditional formatting KO while copying sheet medium NEW
125357 LO Impress do not import eps medium NEW
125484 Updated locale does not update the result of text-resulting formulae medium NEW
125487 Small delay when closing a simple document containing fontwork with pattern fill medium NEW
125596 DOCX: Writer misidentify text language (and appropriate font) in MS Word file (MSO2019) medium NEW
125641 Slow scrolling responsiveness after saving a file with lots of comments medium NEW
125749 Layout on file open is different compared to the saved state medium NEW
125981 The "Default" button for quotes in AutoCorrect options doesn't reset the display of replacement medium NEW
126025 Extrusion on/off is faulty in saving for Fontwork favorite 40 medium NEW
126094 CRASH closing LibreOffice while progress bar dialog is displayed medium NEW
126099 Arc tool goes crazy when drawing proportionally medium NEW
126269 Diagonal lines are sticking out, Calc print range not kept--when printing, for print preview, or exporting PDF. medium NEW
126289 Broken slide preview on Slide pane with enabled OpenGL medium NEW
126327 Conditional formatting: wrong reference when copying the table medium NEW
126344 Undo is slower and consumes more CPU time after pressing undo (compared to 4.4.7.2) medium NEW
126352 “Create Style” Dialogue Does not Work Correctly if Opened via Menu or Toolbar: (often/always) shows other styles than the 'own styles', sometimes inactive when it shouldn't .. medium NEW
126476 FILESAVE DOCX Embedded OLE object not displayed in embedded DOCX file medium NEW
126499 Chart in a form: setmodified(true) won't be executed high NEW
126698 Unable to update links to external files in Calc medium NEW
126715 UI: Hang up/Crash if I enter a space in a form control and then delete with Ctrl+Del medium NEW
126750 Macro not working .xlsm medium NEW
126762 Table style lost on export to HTML medium NEW
126881 CRASH: Closing LibreOffice while file in frame is being loaded medium NEW
126888 Ctrl+Shift+; shortcut to insert current time stopped working medium NEW
126961 Cannot link to macOS address book - crashes and restarts medium NEW
127123 Recently Used Fonts are not stored across sessions when sidebar is used medium NEW
127147 In Burmese some drop cap with numbers are bigger than others medium NEW
127184 AUTO CAPTION: Problems with Image Caption “Figure” in German UI medium NEW
127234 I can't save result of QR-code generator to PNG with good quality medium NEW
127310 Base/BASIC: RectangleShape object does not display an image by setting its FillBitmap medium NEW
127449 Edit->Find in LibreOffice Calc returns "search key not found" when the search term contains an apostrophe. medium NEW
127629 UI: Question to open links when opening a master document in English but different UI language medium NEW
127665 Address Datasource Wizard shows incorrect list of possible datasource types when compared to File> New >Database> connect to exising database medium NEW
127699 trail left by objects while dragging them with arrow keys in LibreOffice Impress medium NEW
127784 FIND & REPLACE DIALOG: Find & Replace Format dialog results in no found medium NEEDINFO
127790 Slide Show mode black screens if a zero width zero height image is inserted on slide medium NEW
127824 Navigation panel won't resize medium NEW
127833 Field shading in comments not properly refreshed medium NEW
128006 Macro warning dialog is prompted on every function or sub call medium NEW
128455 Thumbnails on Start Screen is flickering when I try scroll it with mouse wheel (up-down-up-down) medium NEW
128498 OPTIONS DIALOG: "Update Links when Loading" doesn't work for sections medium NEW
128522 Error for non-existing hyperlink .TXT file "path is not an absolute uRL...:" should instead say "file does not exist" low NEW
128580 Copy text from Word is pasted as an image in Mac OS medium NEW
129166 XCellRangeData::setDataArray is many times slower when data contains some empty strings medium NEW
129457 writer pdf text import crash medium NEW
129542 CRASH: Setting anchor for a formcontrol to character of pageheader leads to crash medium NEW
129824 Crash in: SwDocUpdateField::MakeFieldList_(SwDoc &,int) after "Insert" of a "User Field" with cursor in value field of dialog box ( steps in comment 3 ) medium NEW
129898 Drawings during presentations wouldn't be shown when setting "mouse pointer as pen" in the slide show settings medium ASSIGNED
130004 Navigator mode can no longer be set from its attached Navigation toolbox dialog--OK with tear-away of the floating toolbox medium NEW
130314 LibreOffice 6.4.0.3 hang convert-to pdf 6.4.0.3 medium NEW
130543 Impress doesn't show existing background image in Slide Setup nor in Sidebar (Comment 5) medium NEW
130805 WRITER EDITING: Frame goes out of the shape when added to the shape medium ASSIGNED
130972 FILESAVE "Edit filter settings" grayed out / not accessible in "Save as" dialog of both Calc and Writer medium NEW
131100 : Link to external .ods file returns incorrect data medium NEW
131149 Super/Subscript and Line Spacing options in menu can't be unchecked (with text box objects) medium NEW
131339 calc: #REF! error condition not evaluated for dependent cells, needs recalc, autocalculate failure medium NEW
131634 Crash in sd::View::SdrEndTextEdit(bool) medium NEW
131667 Calc: UI: Edit Cut (or Ctrl+X) without effect - does not cut nor change the clipboard medium NEW
131677 LibreOffice doesn't quit after crash & blocks relaunch medium NEW
131940 Chart disappears after editing the row height medium UNCONFIRMED
131942 UI: No progress bar saving in Calc medium UNCONFIRMED
132075 Crash OutlinerParaObject::OutlinerParaObject medium NEW
132093 Editing snap lines: dialog decreases entered values when drawing scale is 1:many medium UNCONFIRMED
132192 A comment at end of the line isn't included in a mouse selection medium NEW
132279 Deleting first paragraph of a document deletes anchored to object medium NEW
132420 An image is gone after undo medium NEW
132456 Lots of time spend in SfxBroadcaster::RemoveListener Undoing deleting a row (3/4 minutes) medium NEW
132457 #DIV/0! error after undoing a deleting a row medium NEW
132530 Anchor mess after Undo or Redo after Save and reload medium NEW
132563 Empty parameter of type variant does no longer work in sub medium UNCONFIRMED
132590 Export selection cuts off pixels on the right side and at the bottom side medium NEW
132651 UI: Changing the resolution by typing doesn't update width/height field medium UNCONFIRMED
132670 pasting image cut from webpage fails medium NEW
132679 FILEOPEN DOCX Crash when editing formula inline medium UNCONFIRMED
132683 No alt text on image converted to pdf medium NEW
132713 FILEOPEN Old base file (*.dbf) created in LO fails to open in 6.4.2.2 high NEW
132714 Crash when deleting table-row used for diagram generation. high NEW
132763 Page break before enters new page, even if it's the first item medium NEW
132817 Image/anchor is deleting somewhat arbitrarily medium UNCONFIRMED
132900 CUSTOMISE DIALOG: Delay when opening dialog medium UNCONFIRMED
132907 Formatting lost when pressing redo in a specific setup low NEW
132923 Crash in: mergedlo.dll medium UNCONFIRMED
132929 Shape at the wrong position after save and reload caused by undo medium NEW
132930 Anchor changes from to character to paragraph after undo save and reload medium UNCONFIRMED
132934 Memory usage for viewing presentation has increased from 200 to 300 mb medium UNCONFIRMED
132966 Area Bitmap Scrollbar doesn't include newly added items (unreachable) after insertion (only with arrows; or after change to different tab) medium UNCONFIRMED
132975 UI: Ctrl+F11 does not bring focus on combo box 'Select Style' medium NEW
133059 Inserting/Changing header/footer in impress doesn't apply immediately to the current slide medium NEW
133081 With OpenGL rendering sm formula 'lline', 'ldline' bracket lines of matrix are shifted out of node box, default GDI and Skia rendering unaffected medium NEW
133089 MacOS: Some character can't be rendered; square medium NEW
133153 EDITING, FORMATTING comment indicators of hidden columns appear in previous column medium NEW
133201 Linked Image: Changing path to image leads to invisible image in Writer document medium NEW
133228 Moving a cell with mouse shows only black dot instead of helpful cell highlightning medium NEW
133282 That file opens not correct in LibreOffice, but one Word version on phone it open more correct medium NEW
133344 Slow scrolling through preview pages with large complex file medium UNCONFIRMED
133355 High memory usage while in presentation mode with large animated gifs medium UNCONFIRMED
133397 Wrong font size when dragging text from comment box to document medium UNCONFIRMED
133489 swlo.dll crashes when manipulating a table in bad state reached with Alt+Enter & Ctrl+Enter medium NEW
133530 Context menu Paste disabled in Calc with content on the clipboard high UNCONFIRMED
133557 Rejecting track & changes in Calc slow medium UNCONFIRMED
133564 Text OK on button in Autofilter window doesn't show (macOS) medium UNCONFIRMED
133615 RTF Paste doesn't paste the text after the Index medium NEW

216 Total; 216 Open (100%); 0 Resolved (0%); 0 Verified (0%);


In addition all unresolved regressions in LibreOffice might benefit from bibisecting.

Finding bugs already bibisected

For the links to bugzilla queries, please see here.

With the above info added to the bug a developer knows that the regression was introduced between the commits fb754a0df859e30255c25af8fa19bfaa75f257e7 (good) and 2d19e9bb07ccff3134f855812dddfda5c07b1fe4 (bad) on master. A:

git log fb754a0df859e30255c25af8fa19bfaa75f257e7..2d19e9bb07ccff3134f855812dddfda5c07b1fe4

on the source repository will then show the 128 commits including the one that introduced the bug, making it a lot easier for the developer to close in on the culprit. For more details, see:

Special situations

Bibisecting language-specific bugs

The TDF bibisect repositories provided do not include any lang-packs.

To bibisect bugs which work good with english UI, but bad with non-english UI (like CJKs): one should copy-paste the following files, from a release build which has your language, to the same location of the bibisect repo:

  1. program/resource/<your_lang_tag>
  2. share/registry/Langpack-<your_lang_tag>.xcd
  3. share/registry/res/fcfg_langpack_<your_lang_tag>.xcd
  4. share/registry/res/registry_<your_lang_tag>.xcd

The suggested language resources you should copy is the one for the same major branch. For example, for the bibisect-linux-64-6.0 repo, you can copy from 6.0.1.1 release.

Running with a separate user profile

To create separate profile directory in /tmp/ (which will be automatically removed during the next machine boot):

./opt/program/soffice -env:UserInstallation=file:///tmp/soffice-bisect

If you want to start fresh for each bisect iteration, you can add git commit hash to directory name. For example:

./opt/program/soffice \
-env:UserInstallation=file:///tmp/soffice-bisect-$(git rev-parse HEAD)

Finding a fix

Sometimes a bug is a collateral damage of another (possibly minor) bug, in a non obvious way. In such cases that other bug might be fixed on master, but was not backported to the release branch. To identify a problem-fixing commit you can use:

git bisect start --term-new=fixed --term-old=unfixed
git bisect fixed master
git bisect unfixed <some-old-sha> # you can use "git log --reverse" to detect the first revision in the bibisected package

As you test, say

git bisect fixed

or

git bisect unfixed

as appropriate.

If the fix is small and important enough, it likely can be easily backported to the release branch.

Checking out a specific commit based on source hash

Sometimes you already know a specific source commit has/does not have the bug you are hunting.

Copy the source hash from the LibreOffice git history and use it to grep in the bibisect repo log like so:

git log --all --grep='29a9f433c268414747d8ec7343fc2b5987971738'

Copy the commit hash of the bibisect repo and do a checkout for it to verify your assumption:

git checkout 38758b70f5278d4d8292a2e857e80a9a1130f38e

You can use the repo commit hash when determining the bad-good range to bisect:

git bisect start 38758b70f5278d4d8292a2e857e80a9a1130f38e oldest

Doing detective work inside a commit range

In case your bibisect result is a range of commits and you have trouble locating the offending commit, you might make your life easier by searching with a keyword.

An example for a case, where we know the problem is in Calc's Navigator view:

git log --stat --pretty=short --graph 169bd7718264b0e312052757f9bbd2321e1399c2...ff8b873936aa72b17309da4bfc2775573a5b1f55 | grep -B 10 -A 10 --color=always "sc/source/ui/navipi" | less -R

Adjust the -B and -A grep parameters to control how many lines before and after the hit you want to display. When piping to less, -R preserves the colouring of search results.

Bisect skip hell

Sometimes we get stuck in a miserable situation, where we have to use git bisect skip over and over again due to various reasons. There are ways of getting out of these infuriating messes and here we will show one of them.

Example bug: tdf#123095

Bug appeared in 4.0-4.1 range.

There are lots of commits, where the autofilter is not shown at all, so have to skip those.

We can use git bisect visualize to show us the remaining suspected commits:

git bisect visualize --oneline > /some/path/bisect-viz-123095.txt

The earliest bad results are at the top while the ones you have skipped are at the bottom. The commit below the bottom is the last known good one.

My top results included

  b842ac1 source-hash-7b4d76772ef76a8de852ed647ed0cad368f70189
  40ef04e source-hash-dc173b7f2a550185404aacbc6da744cb6d1880fc
  8e697de source-hash-eb96e4325278f31b9e6fbc1d5c6a01543204ded6

So I did git checkout b842ac1, test, continue with the next etc. Turns out the third one from the top was already a skippable commit.

I made a range query with the source hashes in the style bottomcommit..firstbadcommit.

In the displayed results I searched for "filter" and found a suspicious commit about sorting autofilter popup items.

If soffice is failing with a non-zero exit code--this probably means a crash--a solution under #Tidbits for efficiency offers a script to ease the pain of repeatedly skipping failed probes.

Finding source commits from bibisect

If bibisect was done, but not likely to be correct or in a repository known to have large range of source commits, we can check the range by finding a previous build commit from the found one and then find the source range.

$ git log -1 1f14665c5624bc7a502738aa8f4f2bd70a211e72^
$ git log --oneline b6c016da23d309b4ac7d154bc33a22397974ed73..d85fd8a85501547d5bb87822d2589a07aed7f2d6

Troubleshooting

Please add your problems and how you solved them. This section covers issues that affect more than one OS. For OS-specific issues, please see the individual OS wiki pages.

Unable to extract files

If you can't extract files (you should get an error message). Try to rename the file from *.tar.lzma to *.tar.xz.

Installed LibreOffice became modified unexpectedly

Problem / Messages:

   error: Your local changes to the following files would be overwritten by checkout:
     opt/program/pythonloader.pyc
     opt/program/uno.pyc
     opt/program/unohelper.pyc
   Please, commit your changes or stash them before you can switch branches.
   Aborting

Solutions:

git checkout .

will repair the problem. Afterwards you can start the next test run as usual with

git bisect good # or git bisect bad

If that does not solve the problem, you can try

git clean -fd
git reset --hard

The ultimate repair is to delete everything except one

.git/

hidden folder, and do

git checkout oldest

Unable to start soffice

Problem 1: Upon trying to run soffice within bibisect you receive the error "unexpected operator terminate called after throwing an instance of 'com::sun::star::uno::DeploymentException'

Solution: Reset your libreoffice profile located in ~/.config/libreoffice. Make sure to backup the folder if you have any settings you'd like to preserve for use with your stable libreoffice release. After you're done with bibisect you can try to return your backed up profile to it's original location (ie. delete the new profile folder and replace it with the backed up one)

Problem 2: Trying to run soffice within bibisect gives frequent errors such as "Application Error" and skipping via 'git bisect skip' is tedious.

Solution: Upon an error, run one-line script to skip commit on error message and try the next one. Script will stop when soffice is successfully run and then you proceed with 'git bisect good' or 'git bisect bad'. If error is repeated, script can be run again.

 while (git clean -f -X && git bisect skip && ! instdir/program/soffice); do : ; done

How to bisect RTL bugs

In case you need to bisect a RTL ( Right-To-Left ) bug, please import this variable before calling LibreOffice:

SAL_RTL_ENABLED=1

How to bisect File Recovery bugs

In case you need to bisect File Recovery bugs ( e.g. tdf#129210 ), comment out line OOO_DISABLE_RECOVERY=1 in file instdir/program/ooenv

Tidbits for efficiency

The repetitive nature of bibisecting gets tedious fast, so every trick you can use to make the process quicker is valuable. A typical way is to define aliases for complex commands in your .bashrc file.

The .bashrc of an active bibisecter might include a block such as this:

alias bad='git bisect bad && instdir/program/soffice'
alias good='git bisect good && instdir/program/soffice'
alias skip='git bisect skip && instdir/program/soffice'
alias next='git log --reverse --pretty=%H master | grep -A 1 $(git rev-parse HEAD) | tail -n1 | xargs git checkout'
alias prev='git checkout HEAD^1'
alias gallery='rm instdir/program/gengal'
alias pycache='find . | grep -E "(__pycache__|\.pyc|\.pyo$)" | xargs rm -rf'
alias source='if [[ $(git log -1) =~ sha:([[:alnum:]]+) ]]; then git --git-dir ~/libreoffice/.git log -1 ${BASH_REMATCH[1]}; fi'
alias sof="\$( if [[ -d instdir ]] ; then echo instdir ; else if [[ -d opt ]] ; then echo opt ; fi ; fi )/program/soffice --norestore --nologo"

We have commands for jumping to the next or previous commit, "pycache" for dealing with a Windows-specific annoyance and finally "source" for quickly displaying source commit information. The command named "source" assumes you are in a bibisect repository, grabs the source hash of the currently checked out commit and feeds it to a git command targeting a full clone of the LibreOffice source code. To get a breakdown of the command, see the Bash Reference Manual.

The above examples are not exclusive to *nix systems, but work fine in a cygwin environment on Windows. If you want to open documents from the cygwin command line, enclose the ordinary Windows path in single quotes like so:

 instdir/program/soffice 'c:\users\test\downloads\example.ods'

Further information

notes

For details on how the bibisect archives are generated:

We want to make a GUI for bibisect: