Stuff Michael Meeks is doing

This is my (in)activity log. You might like to visit Collabora Productivity a subsidiary of Collabora focusing on LibreOffice support and services for whom I work. Also if you have the time to read this sort of stuff you could enlighten yourself by going to Unraveling Wittgenstein's net or if you are feeling objectionable perhaps here. Failing that, there are all manner of interesting things to read on the LibreOffice Planet news feed.

Older items: 2015: ( J F M ), 2014: ( J F M A M J J A S O N D ), 2013, 2012, 2011, 2010, 2009, 2009, 2008, 2007, 2006, 2005, 2004, 2003, 2002, 2001, 2000, 1999, legacy html


2016-08-05 Friday.

2016-08-04 Thursday.

LibreOffice under the hood: a year of progress from 5.0 to 5.2

Today we release LibreOffice 5.2.0, the next step in our journey, and what will become the base of the increasingly stable 5.2.x series. There is a fine suite of new features for people to enjoy - you can read and enjoy all the great news about the user visible features from many great hackers, but there are, as always, many contributors whose work is primarily behind the scenes, and a lot of work that is more technical than user-facing.

Some moons ago, the ESC decided to add some under-the-hood wiki pages so that people could add their own credits: I encourage you to read those here: 5.1 and 5.2. There are lots of good things there, and it saves me reading and summarizing ~10k commits each release, but then again - that can be fun too. This is my very quick attempt to make up for a year of inactivity on this front, and pluck a few of the un-mentioned bits out of 17,734 commits (that is an average of ~50 commits every day of the year) from liboffice-5-0-branch-point to libreoffice-5-2-branch-point:

Developer Central

A great initiative of Norbert Thiebaud has been to collect together most of the infrastructure and entry points that we have at TDF, and build an attractive list of these to help those new to the project find and use our tools and services. Checkout http://devcentral.libreoffice.org/:

New central site to list developer infrastructure

Replacing Vigra with Cairo

LibreOffice has been able to run in a headless mode, doing its own pixel-bashing for a long time, and this is used intensively by both LibreOffice Online and also the Linux / gtk3 port. It has been a neverending source of amazement to myself and others that the (unreadable) template code using Vigra produces rather poorly performing code for all manner of cases - and needs special case optimization in the client code. One of the great joys of LibreOffice 5.2 is the final replacement of vigra, and the removal of the basebmp directory which allows us to use native (and assembler accelerated on eg. ARM) cairo for pixel bashing. While basebmp has served well and accelerated rendering for years, cairo also gives us accelerated anti-aliased line rendering and more. Thanks to Caolán McNamara (RedHat) for that.

Hardware Acceleration improvements

There were a large number of OpenGL and OpenCL improvements in this time period.

Thanks to all those with more than five commits to vcl/opengl, opencl/ and sc/source/core/opencl/ here: Tomaž Vajngerl (Collabora), Tor Lillqvist (Collabora), Noel Grandin (Peralex), Stephan Bergmann (RedHat), Caolán McNamara (RedHat), Markus Mohrhard, Marco Cecchetti (Collabora)

Performance Improvements

Performance improvements are hard to screenshot; but important nonetheless. We maintain performance regression tests (running under valgrind) at http://perf.libreoffice.org/ - which really helps to pin-point and repair issues as they arise.

One big-win in 5.2 was Armin Le Grand (CIB)'s work to improve our thread-pool, and use it to accelerate the 3D software renderer - which gives a particularly noticable speedup for 3D chart re-rendering.

Crash Reporting

Markus Mohrhard has done some simply excellent work on crash reporting - to help us find the most frequent crashes on Windows. While many Linux distributions have had similar tools deployed for years, covering Windows is important too. The implementation re-uses Google's Breakpad to create minidumps which are analyzed on the server side and charted prettily at http://crashreport.libreoffice.org/stats/

Built in Crash Report analysis web service

Markus would love some help from someone with web development skills to help improve the front-end, and analytic / querying / data presentation here. Please poke the developer list libreoffice@lists.freedesktop.org.

This work has already lead to several vital fixes of the top crashers that have been seen in the wild, using good data to nail the worst quality issues. Thanks to Markus Mohrhard, Caolán McNamara (RedHat), and Miklos Vajna (Collabora) who have commits referencing crashreport URLs.

Ongoing Code quality work

Work is ongoing around code quality in many areas, with 196 or so cppcheck fixes thanks to Caolán McNamara (RedHat), Julien Nabet, Jochen Nitschke, Noel Grandin (Peralex), Michael Weghorn, Takeshi Abe, Giuseppe Castagno and others.

Caolan and the RedHat guys manage to keep the Coverity scan count, and crash-testing (loading and saving ~91k documents to many formats) counts at or around zero at all times, as well as doing fuzzing and other cleanup.

Lifecycle Improvements

Continuing the VclPtr re-work where we added strong referenced lifecycle to all our widgets, Dipankar Niranjan in tdf#96888 has cleaned out all of the old & awful 'dog-tag' work that tried to get lifecycle right in VCL, using much cleaner references. In more recent times Yurtoglu, Melike Ayse and Noel Grandin have worked to abstract the VclReferenceBase and apply this to Menus, to ensure they are correctly lifecycle managed. Thanks too to Jocken Nitschke for internalizing the DeletionListener tdf#97525 which should be removed when we eventually reference count the sal/ backend resources.

Other great work to exorcise manual refcounting comes from Thomas Arnhold, Daniel Robertson, Noel Grandin, Aleksas Pantechovskis and especially Xisco Fauli for their work on tdf#96525 and tdf#89329, converting lots of manually reference counted or copy-on-write structures to using the nice cow_wrapper template; as well as converting pImpl pointers to use std::unique_ptr. This reduces the scope for programmer error, and missed corner cases and allows us to make copy-on-write ref-counting thread-safe if necessary. There are 140 cases fixed, and about 68 refcounting instances still needing love.

Unit testing

We continued to build and execute more critical unit tests this year - each one stopping some suite of regressions from ever returning. Grepping for the relevant TEST and ASSERT macros we continue to grow the number of unit tests:

Graph of number of unit tests and assertions
Our ideal is that every bug that is fixed gets a unit test to stop it ever recurring. With around 1800 commits (20% up on last year), and over one hundred committers to the unit tests in the range it is hard to list everyone involved here, apologies for that; what follows is a sorted list of those with over 20 commits to the relevant directories in both core.git and online.git: Miklos Vajna (Collabora), Caolán McNamara (RedHat), Stephan Bergmann (RedHat), Ashod Nakashian (Collabora), Noel Grandin (Peralex), Markus Mohrhard, Tor Lillqvist (Collabora), Eike Rathke (RedHat), Michael Stahl (RedHat), Henry Castro (Collabora), Chris Sherlock, Varun, Andrea Gelmini, Jan Holesovsky (Collabora), Takeshi Abe, Łukasz Hryniuk, Xisco Fauli, Mike Kaganski (Collabora) and those with over 10 commits get an honourable mention too - unit tests are important ! David Tardon (RedHat), Katarina Behrens (CIB), Marco Cecchetti (Collabora), Tomaž Vajngerl (Collabora), Oliver Specht (CIB), Zdeněk Crhonek, Mark Hung, Justin Luth, Julien Nabet, Aleksas Pantechovskis, Pranav Kant (Collabora)

LibreOfficeKit Improvements

The LibreOfficeKit API is the foundation of the Android App, GNOME Documents, and the ongoing LibreOffice Online work, and a lot changed in the last year. The two main building blocks of the LOK API are the methods of the exposed objects, and the callback types. Since 5.0, the following new methods has been added:

And the following new callbacks are available: Thanks to Andrzej Hunt (Collabora), Ashod Nakashian (Collabora), Henry Castro (Collabora), Jan Holesovsky (Collabora), Michael Stahl (RedHat), Mihai Varga (Collabora), Miklos Vajna (Collabora), Oliver Specht (CIB) and Pranav Kant (Collabora) for these.

Miscellaneous

An outcome of our Turkish Hackfest in Ankarah was discovering that LibreOffice would not even build in the tr_TR.UTF-8 locale. Interestingly toupper('i') != 'I' in this locale; fun cf. tdf#99589. Thanks to Krishna Keshav, Gökhan Gurbetoğlu and Apurva Priyadarshi for the fixes.

A large number of UX / usability papercuts were fixed and improved such as keyboard shortcuts, consistent display issues, mis-sized and mis-placed controls, and some regressions from UI file conversion. Thanks to Caolán McNamara (RedHat), Akshay Deep, Regina Henschel, Maxim Monastirsky, Jürgen Funk (CIB), Bubli Behrens (CIB), Samuel Mehrbrodt (CIB) & Jay Philips.

QA / bugzilla

One metric we watch in the ESC call is who is in the top ten in the freedesktop Weekly bug summary. Here is a list of the people who have appeared more than ten times in the weekly list of top bug closers in order of frequency of appearance: V Stuart Foote, Adolfo Jayme, Cor Nouws, Maxim Monastirsky, Eike Rathke (RedHat), raal, m.a.riosv, Julien Nabet, Caolán McNamara (RedHat), Miklos Vajna (Collabora), Beluga, Alex Thurgood, Michael Meeks (Collabora), Buovjaga, Yousuf (Jay) Philips, Joel Madero, Samuel Mehrbrodt (CIB), Markus Mohrhard, Timur, Jean-Baptiste Faure, Xisco Faulí, Aron Budea, tommy27, Michael Stahl (RedHat), Heiko Tietze, David Tardon, Laurent BP With many thanks to everyone else that helped to close and triage so many bugs for this release.

Jenkins / CI

Thanks fundamentally to Norbert Thiebaud - we now have not only great Jenkins / CI infrastructure, with gerrit integration - but we have a much enlarged and more reliable hardware build farm that encourages people to use Jenkins to check their work before pushing, in turn increasing the quality and reliability of master. This year we've seen the benefits of running our full suite of make check unit tests on our debugging builds under Linux.

The work Jenkins did for just master in the six month run up to the 5.2 branch point we have 34,124 tinderbox builds covering seven configuration across linux, mac and windows. With 27,737 builds covering three platforms tested on our gerrit infrastructure. This is for the CI managed hardware, there are a number of other volunteer run Tinderbox builders. This is extremely helpful for keeping master build-able and usable, making it easy for newbies to get stuck in. With 60,000 builds for 8k commits we are doing a lot of loop test and validation of the LibreOffice code at CI time.

Ongoing German Comment redux

Some of my favorite heroes are those who open up the code so that others can work on it ! One of the key tasks there is translating the remaining German Comments (a list). The last four thousand lines seem to defy translation - why this graph should flatten like this - I have simply no idea. All patches from German speakers who love to finish things - much appreciated. Many thanks to those who stuck with it, with more than 2 commits; in order of commit count: Albert Thuswaldner, Phillip Sz, Thomas Klausner, Chris Sherlock, Philipp Weissenbacher & Matteo Casalin. We are now down to seven modules left: include, reportdesign, sc, sfx2, stoc, svx, sw

Graph of remaining lines of German comment to translate

Windows XP

The 5.2.x releases run well on Windows XP, but we cannot be sure how long our tooling will continue to target that platform. As such - while the ESC has no concrete plans to drop Windows XP support, we are 'deprecating' it after the 5.2.x series - meaning that having a modern C++ compiler and a modern Windows build OS base-line have a higher priority. That means that in future it is possible that future major LibreOffice releases may not run on Windows XP; you have been warned. For now, there is no change here.

Getting involved

I hope you get the idea that more developers continue to find a home at LibreOffice and work together to complete some rather significant work both under the hood, and also on the surface. If you want to get involved there are plenty of great people to meet and work alongside. As you can see individuals ('Assigned') make a huge impact to the diversity of LibreOffice (the colour legends on the right should be read left to right, top to bottom, which maps to top down in the chart):

Graph showing individual code committers per month

These charts, made so early in the month are still missing som individuals and commits queued up in gerrit for review - hence the July numbers. In terms of diversity of code commits, we love to see the unaffiliated volunteers contribution by volume, though clearly the volume and balance changes with the season, release cycle, and volunteers vacation / business plans:

Graph showing individual code committers per month

Naturally we maintain a list of small, bite-sized tasks which you can use to get involved at our Easy Hacks page, with simple build / setup instructions. It is extremely easy to build LibreOffice, each easy-hack should have code pointers and be a nicely self contained task that is easy to solve. In addition some of them are really nice-to-have features or performance improvements. Please do consider getting stuck in with something.

Another thing that really helps is running pre-release builds and reporting bugs just grab and install a pre-release and you're ready to contribute alongside the rest of the development team.

Conclusion

LibreOffice 5.2 is great; it is made by a set of developers having fun, working together, and building an increasingly attractive and beautiful Free Software Office suite, I hope you enjoy using it. Thanks for reading, don't forget to checkout the user visible feature page and thank you for supporting LibreOffice.

If I have missed your good work out (and this is a very incomplete view based on a few hours of analysis) - please do add yourself to the relevant wiki page and potentially mail me a unified diff to this page; thanks !

Raw data and commit stats built using our gitdm-config - are available for many of the above graphs.

2016-08-03 Wednesday.

2016-08-02 Tuesday.

2016-08-01 Monday.

2016-07-31 Sunday.

2016-07-30 Saturday.

2016-07-29 Friday.

2016-07-28 Thursday.

2016-07-27 Wednesday.

2016-07-26 Tuesday.

2016-07-25 Monday.

2016-07-24 Sunday.

2016-07-23 Saturday.

2016-07-22 Friday.


My content in this blog and associated images / data under images/ and data/ directories are (usually) created by me and (unless obviously labelled otherwise) are licensed under the public domain, and/or if that doesn't float your boat a CC0 license. I encourage linking back (of course) to help people decide for themselves, in context, in the battle for ideas, and I love fixes / improvements / corrections by private mail.

In case it's not painfully obvious: the reflections reflected here are my own; mine, all mine ! and don't reflect the views of Collabora, SUSE, Novell, The Document Foundation, Spaghetti Hurlers (International), or anyone else. It's also important to realise that I'm not in on the Swedish Conspiracy. Occasionally people ask for formal photos for conferences or fun.

Michael Meeks (michael.meeks@collabora.com)

Made with PyBlosxom