skip to main content

Midori LogoMidori

a lightweight, fast, and free web browser

Contribute

Contribute

This document is licensed under the LGPL 2.1.

Check out the sources

bzr branch lp:midori

The development trunk (master, tip) is the latest iteration of the next release. Browse it online and look for other branches at http://code.launchpad.net/midori or download a tarball of the latest revision.

The code used to be hosted in git.xfce.org/apps/midori.

Keep your copy updated:

bzr merge --pull

Join IRC chat rooms

Join #midori on Freenode or use webchat to talk about Midori, discuss bugs and new ideas.

Contribute other than touching code

Documentation resources

Build the code

mkdir _build
cd _build
cmake -DCMAKE_INSTALL_PREFIX=/usr ..
make
sudo make install

Advanced Tip: Pass ”-G Ninja” to cmake to use Ninja instead of make (usually packaged as ninja or ninja-build).

If using GTK+3 you'll want to add

-DUSE_GTK3=1

to the cmake command line.

Midori can be run without being installed.

_build/midori/midori

You can use a temporary folder for testing without affecting normal settings

_build/midori/midori -c /tmp/midoridev

You'll want to unit test the code if you're testing a new version or contributed your own changes:

xvfb-run make check

Automated daily builds in Launchpad (ppa:elementary-os/daily and ppa:midori/midori-dev) run these tests as well.

Debugging issues

Testing an installed release may reveal crashers or memory corruption which require investigating from a local build and obtaining a stacktrace (backtrace, crash log).

_build/midori/midori -g [OPTIONAL ARGUMENTS]

If the problem is a warning, not a crash GLib has a handy feature

env G_DEBUG=all _build/midori/midori -g

For more specific debugging output, depending on the feature in question you may use

env MIDORI_DEBUG=help _build/midori/midori

Whilst -g is convenient you may want to use proper gdb:

gdb
file _build/midori/midori
run
…
bt

On Windows you can open the folder where Midori is installed and double-click gdb.exe. A black command line window should appear.

file midori.exe
run
…
bt

To verify a regression you might need to revert a particular change:

# Revert only r6304
bzr merge . -r 6304..6303

Coding style and quality

Midori code should in general have:

  • 4 space indentation, no tabs
  • Between 80 to 120 columns
  • Prefer /* */ style comments
  • Call variables animal and animal_shelter instead of camelCase
  • Keep a space between functions/ keywords and round parentheses

For Vala:

  • Prefer new Gtk.Widget () over using Gtk; new Widget ()
  • Stick to standard Vala-style curly parentheses on the same line
  • Cuddled } else { and } catch (Error error) {

For C:

  • Always keep { and } on their own line

Extensions may historically diverge from the standard styling on a case-by-case basis

Committing code

Tell Bazaar your name if you haven't yet

  bzr whoami "Real Name <email@address>"

See what you did so far

  bzr diff

Get an overview of changed and new files

  bzr status

Add new files, move/ rename or delete

  bzr add FILENAME
  bzr mv OLDFILE NEWFILE
  bzr rm FILENAME

Commit all current changes - Bazaar automatically picks up edited files. If you're used to git, think of an implicit staging area.

  bzr commit -p

If you have one or more related bug reports you should pass them as arguments. Once these commits are merged the bug will automatically be closed and the commit log shows clickable links to the reports.

  bzr commit -p --fixes=lp:1111999

If you've done several commits

  bzr log | less
  bzr log -p | less

In the case you committed something wrong or want to ammend it:

  bzr uncommit

If you end up with unrelated debugging code or other patches in the current changes, it's sometimes handy to temporarily clean up. This may be seen as bzr's version of git stash.

  bzr shelve
  bzr commit -p
  bzr unshelve

Remember to keep your branch updated:

  bzr merge --pull

As a general rule of thumb, bzr help COMMAND gives you an explanation of any command and bzr help commands lists all available commands.

If you're a die-hard git user, checkout git-lp to use git commands with the Bazaar repository.

Push proposed changes

If you haven't yet, check that Launchpad has your SSH key - you can create an SSH key with Passwords and Keys aka Seahorse or ssh-keygen -t rsa - and use bzr launchpad-login to make youself known to bzr locally.

If you checked out trunk, and added your patch(es), just push it under your username in Launchpad and you can propose it for merging into trunk. This will automatically request a review from other developers who can then comment on it and provide feedback.

bzr push --remember lp:~USERNAME/midori/fix-bug1120383 && bzr lp-propose-merge lp:midori

lp-propose-merge command may not be working on some distributions like Arch or Fedora. In case you get error like bzr: ERROR: Unable to import library “launchpadlib”: No module named launchpadlib just use Launchpad's Web UI to propose a merge.

What happens to all the branches?

Leave the branches alone, approved branches are cleared automatically by Launchpad.

For larger feature branches, use the team in Launchpad to allow other developers to work on the code with you.

bzr push --remember lp:~midori/midori/featuritis && bzr lp-propose-merge lp:midori

What if I want to help out on an existing merge request that I can't push to?

bzr branch ~OTHERPERSON/midori/fix-bug1120383
cd fix-bug1120383
# make commits
bzr push lp:USERNAME~/midori/fix-bug1120383
bzr lp-propose-merge ~OTHERPERSON/midori/fix-bug1120383

Updating a branch that may be out of sync with trunk:

bzr pull
bzr: ERROR: These branches have diverged
bzr merge lp:midori
# Hand-edit conflicting changes
bzr resolve FILENAME
# If any conflicts remain continue fixing
bzr commit -m 'Merge lp:midori'

Save a little bandwidth, branch from an existing local copy that you keep around:

bzr branch lp:midori midori
bzr branch midori midori.fix-bug1120383
cd midori.fix-bug1120383
bzr pull lp:midori

Backwards compatibility

As of Midori 0.5.4 the formula is:

  • Required dependencies need to be available on the previous stable Fedora and Ubuntu
  • For reference OpenBSD
  • Windows XP through 8 are to date ABI compatible, all dependencies are included
package F17 (2012-05-29) U 12.10 (2012-10-18)
glib2 2.32.4 2.34.0
vala 0.16.1 0.16
gtk3 3.4.4 3.6.0
gtk2 2.24.13 2.24.13
soup 2.38.1 2.40
webkit 1.8.3-1.fc17 1.10.0-0ubuntu1

Midori with(out) Granite

When built with Granite (-DUSE_GRANITE=1 or –enable-granite) there're a few key differences:

Midori for Windows

For Linux developers

Dependencies

Midori for Windows is compiled on a Linux host and MinGW stack. For the current build Fedora 18 packages are used. Packages needed are listed below:

yum install gcc vala intltool

For a native build

yum install libsoup-devel webkitgtk3-devel sqlite-devel

For cross-compilation

yum install mingw{32,64}-webkitgtk3 mingw{32,64}-glib-networking mingw{32,64}-gdb mingw{32,64}-gstreamer-plugins-good

Packages needed when assembling the archive

 yum install faenza-icon-theme p7zip mingw32-nsis greybird-gtk3-theme

Installing those should get you the packages needed to successfully build and develop Midori for Win32.

Building

For 32-bit builds:

mkdir _mingw32
cd _mingw32
mingw32-cmake .. -DUSE_ZEITGEIST=0 -DUSE_GTK3=1 -DCMAKE_INSTALL_PREFIX=/usr/i686-w64-mingw32/sys-root/mingw -DCMAKE_VERBOSE_MAKEFILE=0
make
sudo make install

For 64-bit builds:

mkdir _mingw64
cd _mingw64
mingw64-cmake .. -DUSE_ZEITGEIST=0 -DUSE_GTK3=1 -DCMAKE_INSTALL_PREFIX=/usr/x86_64-w64-mingw32/sys-root/mingw -DCMAKE_VERBOSE_MAKEFILE=0
make
sudo make install

Once built and tested you can assemble the Midori archive with a helper script 32-bit build:

env MINGW_PREFIX="/usr/i686-w64-mingw32/sys-root/mingw" ./win32/makedist/makedist.midori

64-bit build:

env MINGW_PREFIX="/usr/x86_64-w64-mingw32/sys-root/mingw/" ./win32/makedist/makedist.midori x64

Testing

For testing your changes unfortuantely a real system is needed because Midori and WebKitGTK+ don't work properly under Wine. Even if it works some problems are not visible when using Wine, but are present when running under a real Windows system and vice versa.

One way around it is to virtualize Windows on a Linux host and mount your MinGW directories as a network drive or shared folder.

For Windows developers

Rough list of prerequisites for building with MinGW on Windows

If in doubt whether to get 32 or 64 bit versions use 32 bit ones, they are more universal and tend to be less broken.

MinGW compiler

Compiler should match the one that was used to build packages ideally.

  • We will user *mingw64 rubenvb* release
  • Lastest stable release is gcc 4.8.0

Releases

Download

7zip

We will need 7zip to extract various archives

Homepage

32bit Installer

Python3 (to extract rpms)

We will need python3 to use download-mingw-rpm.py script. If you don't plan to use it you can safely skip this step.

We get python3, whatever is the lastes stable release.

Releases

Download

Installer

Install Python and be sure to check “addd python.exe to path” installer checkbox.

download-mingw-rpm.py

We get download-mingw-rpm.py script from github. It uses Python3 and should fetch and unpack rpm files for us.

View Script

Download Script

Usage:

  • Launch cmd.exe
  • Navigate to folder where the script was saved
  • Make sure that python can access 7z.exe
  • Run command and wait, it should extract the packages into your current directory
c:\Python33\python.exe download-mingw-rpm.py -u http://ftp.wsisiz.edu.pl/pub/linux/fedora/linux/updates/18/i386/ --deps mingw32-webkitgtk mingw32-glib-networking mingw32-gdb mingw32-gstreamer-plugins-good

Fedora 18 packages

The above URL for some reason does not work with the script.

MSYS

Msys contains shell and some small utilities

Download

CMake

Homepage Installer

When installing check the installer checkbox “add to path”

Bazaar

Homepage

We will get 2.4 Stable Release (standalone)

Installer

When installing check the installer checkbox “add to path”

Vala

Globbing it all together

Extracted rpms msys and mingw packages should form uniform unix like folder. You use msys.bat to launch a shell

Jargon

  • freeze: a period of bug fixes only eg. 4/2 cycle means 4 weeks of features and 2 weeks to focus on resolving existing problems
  • MR: merge request, a branch proposed for review
  • ninja: an internal tab, usually empty label, used for taking screenshots
  • fortress: user of an ancient release like 0.4.3 as found on Raspberry Pie, Debian, Ubuntu
  • katze, sokoke, tabby: API names and coincidentally cat breeds

Source / Edit