mozilla

Revision 36361 of Simple Thunderbird build

  • Revision slug: Simple_Thunderbird_build
  • Revision title: Simple Thunderbird build
  • Revision id: 36361
  • Created:
  • Creator: mconley
  • Is current revision? No
  • Comment 2 words added, 4 words removed

Revision Content

This page covers the basic steps needed to build a bleeding-edge, development version of Thunderbird. For additional, more detailed information, see the build documentation.

Preparing your system

Before you can build Thunderbird, you'll need the build tools listed below and a few gigabytes of free disk space. Builds will be slow unless you have at least 2GB of RAM.

Linux

Run the following commands in a shell to install the needed tools:

Ubuntu users:

sudo apt-get build-dep thunderbird
sudo apt-get install mercurial libasound2-dev libcurl4-openssl-dev libnotify-dev libxt-dev libiw-dev mesa-common-dev autoconf2.13 yasm

Debian users: Same as Ubuntu, but replace the first command with sudo apt-get build-dep icedove

Fedora users:

sudo yum groupinstall 'Development Tools' 'Development Libraries' 'GNOME Software Development'
sudo yum install mercurial autoconf213 glibc-static libstdc++-static yasm wireless-tools-devel mesa-libGL-devel alsa-lib-devel libXt-devel

Problems? See Linux build prerequisites.

Mac

  • Install Xcode 3. You can download this from Apple, or install it from the OS DVDs that came with your Mac.
  • If you're using OS X 10.6.5 or later, install Java Developer Package for Mac (for a file required by the MacPorts packages we install below).
  • Install MacPorts, and then run these commands in a shell:
    sudo port sync
    sudo port install mercurial libidl autoconf213 yasm
    
  • homebrew is an alternative to MacPorts. Thunderbird uses an older version of autoconf, so you need to use an alternate brew recipe from the homebrew's Github site.
    sudo easy_install pip
    sudo pip install Mercurial
    sudo brew install libidl yasm
    sudo brew install https://raw.github.com/Homebrew/homebrew-versions/master/autoconf213.rb

Problems? See Mac OS X build prerequisites.

Windows

  • Make sure your system is up-to-date through Windows Update. Windows XP needs at least Service Pack 2 and .NET Framework 2.0.
  • Install Visual C++ 2005 Professional, VC++ 2008 Professional or Express with SP1 (free), or Visual C++ 2010 Professional or Express (free). VC++ 2008 Express without SP1 will not work.
  • You may need to install one or more Windows SDKs. See Windows SDK versions for a quick guide.
  • Install the June 2010 DirectX SDK.
  • Install MozillaBuild, a package of additional build tools. (If you see a Windows error dialog giving you the option to re-install with the 'correct settings', choose that option and after that all should be well.) (Another option is to use pymake, a Python implementation of Make that uses Window's multi-core architectur  e and thus significantly speeds up build time. See Mike Conley's blog post for more information.)

The rest of the build steps are done from the MSYS shell installed with MozillaBuild. Use the shortcuts on your desktop, or run c:\mozilla-build\start-msvcX.bat (where X is 8 for 2005, 9 for VS 2008 and 10 for VS 2010). Even if you're on 64-bit Windows, do not use the start-msvcX-x64.bat files (unless you know what you're doing). Those files are experimental and unsupported. See the Build:MozillaBuild For x64 wiki page.

Problems? See Windows build prerequisites.

Get the source

Note: On Windows, you won't be able to build the Thunderbird source code if it's under a directory with spaces in the path (e.g. don't use "Documents and Settings"). You can pick any other location, such as a new directory C:\thunderbird-src

Get the latest source code from Mozilla's comm-central Mercurial code repository.

hg clone http://hg.mozilla.org/comm-central 

Then, get all the repositories it depends on. The comm-central repository includes a script to do just that. This may take a while, it's a lot of code! First, cd into the comm-central subdirectory (created automatically by the previous command), then run:

python client.py checkout

Build configuration (optional)

By default, the build system creates a release build of Thunderbird roughly equivalent to the official Firefox release builds. If that's not exactly what you want, there are many build configuration options to choose from, although it's strongly recommended that you only use options that you fully understand. The normal way to specify build options is to place them in a file called '.mozconfig' at the root of your mozilla source tree. For example, to create a debug build instead of a release build, that file would contain:

ac_add_options --enable-debug

For more on configuration options, see the page Configuring build options.

Building Thunderbird

On Windows, you are strongly advised to use PyMake instead, since Windows parallel builds are not reliable when using GNU make. In addition, PyMake recurses in a single process reducing the number of shell invocations, which are particularly expensive on Windows. See Mike Conley's blog post for more information.

On Mac OS X, and GNU/Linux to start the build, cd into the subdirectory (created automatically by the hg clone command), and run:

make -f client.mk

Building can take a significant amount of time, depending on your system, OS and chosen build options. Linux builds on a fast box may take under 15 minutes, but Windows builds on a slow box may take several hours. Tips for making builds faster.

Various compiled files, libraries, and the Thunderbird executable will be found in your object directory (under comm-central/), which is prefixed with obj-. The exact name depends on your system and OS. For example, a Mac user may get an object directory name of obj-x86_64-apple-darwin10.7.3/.

From the object directory, Windows users should run mozilla/dist/bin/thunderbird.exe, Linux users should run mozilla/dist/bin/thunderbird, and OS X users should run dist/Daily.app/Contents/MacOS/thunderbird.

Building Thunderbird and Lightning

If you've set up you build environment as above, then all you need to do is:

echo 'ac_add_options --enable-calendar' >> .mozconfig

in the comm-central directory, or just add the ac_add_options --enable-calendar line to your .mozconfig with your favourite editor.

Then just re-run the "make -f client.mk" command above (you can do the addition before running make for the first time)

How to build again later

In your comm-central directory, run the same command as before:

python client.py checkout

Then just re-run the "make -f client.mk" command above. make will only recompile files that changed, but it's still a long haul. An incremental build can be faster.

Problems Building?

Have you:

  • Checked the Thunderbird tinderbox for known failures at the time you pulled the code?
    • If the trunk is broken, you may wish to consider building one of the branches (to pull the source code from a branch, just replace the url to the repository in the hg clone instruction)
  • Have you searched the bug database for issues relating to your problem (e.g. platform specific issues)?
  • Try asking in mozilla.dev.builds - don't forget to include details of what is in your mozconfig, and what the actual error is.

References

Revision Source

<p>This page covers the basic steps needed to build a bleeding-edge, development version of Thunderbird. For additional, more detailed information, see the <a class="internal" href="../../../../En/Developer_Guide/Build_Instructions" rel="internal">build documentation</a>.</p>
<h2 class="editable"><span>Preparing your system</span></h2>
<p>Before you can build Thunderbird, you'll need the build tools listed below and a few gigabytes of free disk space. Builds will be slow unless you have at least 2GB of RAM.</p>
<h3 class="editable"><span>Linux</span></h3>
<p>Run the following commands in a shell to install the needed tools:</p>
<p><strong>Ubuntu</strong> users:</p>
<pre>sudo apt-get build-dep thunderbird
sudo apt-get install mercurial libasound2-dev libcurl4-openssl-dev libnotify-dev libxt-dev libiw-dev mesa-common-dev autoconf2.13 yasm
</pre>
<p><strong>Debian</strong> users: Same as Ubuntu, but replace the first command with <code>sudo apt-get build-dep icedove</code></p>
<p><strong>Fedora</strong> users:</p>
<pre>sudo yum groupinstall 'Development Tools' 'Development Libraries' 'GNOME Software Development'
sudo yum install mercurial autoconf213 glibc-static libstdc++-static yasm wireless-tools-devel mesa-libGL-devel alsa-lib-devel libXt-devel
</pre>
<p>Problems? See <a href="../../../../En/Developer_Guide/Build_Instructions/Linux_Prerequisites" rel="internal">Linux build prerequisites</a>.</p>
<h3 class="editable"><span>Mac</span></h3>
<ul> <li>Install <a class="link-https" href="https://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/wa/getSoftware?bundleID=20792" rel="external nofollow" target="_blank" title="https://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/wa/getSoftware?bundleID=20792">Xcode 3</a>. You can download this from Apple, or install it from the OS DVDs that came with your Mac.</li> <li>If you're using OS X 10.6.5 or later, install <a class="external" href="http://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/wa/getSoftware?bundleID=20719" rel="external nofollow" target="_blank" title="http://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/wa/getSoftware?bundleID=20719">Java Developer Package for Mac</a> (for a file required by the MacPorts packages we install below).</li> <li>Install <a class="external" href="http://www.macports.org/install.php" rel="external nofollow" target="_blank" title="http://www.macports.org/install.php">MacPorts</a>, and then run these commands in a shell: <pre class="eval">sudo port sync
sudo port install mercurial libidl autoconf213 yasm
</pre> </li> <li><a class="link-https" href="https://github.com/mxcl/homebrew" rel="external nofollow" target="_blank" title="https://github.com/mxcl/homebrew">homebrew</a> is an alternative to MacPorts. Thunderbird uses an older version of autoconf, so you need to use an alternate brew recipe from the homebrew's Github site. <pre>sudo easy_install pip
sudo pip install Mercurial
sudo brew install libidl yasm
sudo brew install https://raw.github.com/Homebrew/homebrew-versions/master/autoconf213.rb</pre> </li>
</ul>
<p>Problems? See <a class="internal" href="../../../../En/Developer_Guide/Build_Instructions/Mac_OS_X_Prerequisites" rel="internal">Mac OS X build prerequisites</a>.</p>
<h3 class="editable"><span>Windows</span></h3>
<ul> <li>Make sure your system is up-to-date through Windows Update. Windows XP needs at least <a class="external" href="http://www.microsoft.com/windowsxp/sp2/default.mspx" rel="external nofollow" target="_blank" title="http://www.microsoft.com/windowsxp/sp2/default.mspx">Service Pack 2</a> and <a class="external" href="http://www.microsoft.com/downloads/info.aspx?na=47&amp;p=3&amp;SrcDisplayLang=en&amp;SrcCategoryId=&amp;SrcFamilyId=4377f86d-c913-4b5c-b87e-ef72e5b4e065&amp;u=details.aspx?familyid=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&amp;displaylang=en" rel="external nofollow" target="_blank" title="http://www.microsoft.com/downloads/info.aspx?na=47&amp;p=3&amp;SrcDisplayLang=en&amp;SrcCategoryId=&amp;SrcFamilyId=4377f86d-c913-4b5c-b87e-ef72e5b4e065&amp;u=details.aspx?familyid=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&amp;displaylang=en">.NET Framework 2.0</a>.</li> <li>Install Visual C++ 2005 Professional, VC++ 2008 Professional or <a class="external" href="http://www.microsoft.com/downloads/details.aspx?FamilyId=F3FBB04E-92C2-4701-B4BA-92E26E408569&amp;displaylang=en" rel="external nofollow" target="_blank" title="http://www.microsoft.com/downloads/details.aspx?FamilyId=F3FBB04E-92C2-4701-B4BA-92E26E408569&amp;displaylang=en">Express with SP1 (free)</a>, or Visual C++ 2010 Professional or <a class="external" href="http://go.microsoft.com/?linkid=9709949" rel="external" target="_blank" title="http://go.microsoft.com/?linkid=9709949">Express (free)</a>. VC++ 2008 Express without SP1 will not work.</li> <li>You may need to install one or more Windows SDKs. See <a class="internal" href="../../../../En/Windows_SDK_versions" rel="internal">Windows SDK versions</a> for a quick guide.</li> <li>Install the <a class="external" href="http://www.microsoft.com/download/en/details.aspx?displaylang=en&amp;id=6812" rel="external nofollow" target="_blank" title="http://www.microsoft.com/download/en/details.aspx?displaylang=en&amp;id=6812">June 2010 DirectX SDK</a>.</li> <li>Install <a class="external" href="http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/MozillaBuildSetup-Latest.exe" rel="external nofollow" target="_blank" title="http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/MozillaBuildSetup-Latest.exe">MozillaBuild</a>, a package of additional build tools. (If you see a Windows error dialog giving you the option to re-install with the 'correct settings', choose that option and after that all should be well.) (Another option is to use <a class="external" href="http://benjamin.smedbergs.us/pymake/" title="http://benjamin.smedbergs.us/pymake/">pymake</a>, a Python implementation of Make that uses Window's multi-core architectur  e and thus significantly speeds up build time. See <a class="external" href="http://mikeconley.ca/blog/2011/11/30/build-thunderbird-faster-on-windows/" title="http://mikeconley.ca/blog/2011/11/30/build-thunderbird-faster-on-windows/">Mike Conley's blog post</a> for more information.)</li>
</ul>
<p>The rest of the build steps are done from the MSYS shell installed with MozillaBuild. Use the shortcuts on your desktop, or run <code>c:\mozilla-build\start-msvc<strong>X</strong>.bat</code> (where X is 8 for 2005, 9 for VS 2008 and 10 for VS 2010). <strong>Even if you're on 64-bit Windows, do not use the <code>start-msvcX-x64.bat</code> files </strong>(unless you know what you're doing). Those files are <strong>experimental</strong> and <strong>unsupported</strong>. See the <a class="external" href="http://wiki.mozilla-x86-64.com/How_To_Build_Windows_x64_Build" rel="external nofollow" target="_blank" title="http://wiki.mozilla-x86-64.com/How_To_Build_Windows_x64_Build">Build:MozillaBuild For x64 wiki page</a>.</p>
<p>Problems? See <a class="internal" href="../../../../En/Developer_Guide/Build_Instructions/Windows_Prerequisites" rel="internal">Windows build prerequisites</a>.</p>
<h2>Get the source</h2>
<div class="note"><strong>Note:</strong> On Windows, you won't be able to build the Thunderbird source code if it's under a directory with spaces in the path (e.g. don't use "Documents and Settings"). You can pick any other location, such as a new directory C:\thunderbird-src</div>
<p>Get the latest source code from Mozilla's <code>comm-central</code> Mercurial code repository.</p>
<pre>hg clone http://hg.mozilla.org/comm-central 
</pre>
<p>Then, get all the repositories it depends on. The comm-central repository includes a script to do just that. This may take a while, it's a lot of code! First, cd into the <code>comm-</code><code>central </code>subdirectory (created automatically by the previous command), then run:</p>
<pre>python client.py checkout
</pre>
<h2 class="editable">Build configuration (optional)</h2>
<p>By default, the build system creates a release build of Thunderbird roughly equivalent to the official Firefox release builds. If that's not exactly what you want, there are many build configuration options to choose from, although it's <strong>strongly</strong> recommended that you only use options that you fully understand. The normal way to specify build options is to place them in a file called '.mozconfig' at the root of your mozilla source tree. For example, to create a debug build instead of a release build, that file would contain:</p>
<pre>ac_add_options --enable-debug
</pre>
<p>For more on configuration options, see the page <a href="/en/Configuring_Build_Options" rel="internal" title="en/Configuring Build Options">Configuring build options</a>.</p>
<h2>Building Thunderbird</h2>
<div class="note">On Windows, you are <strong>strongly advised</strong> to use <a href="/en/pymake" rel="internal" title="pymake">PyMake</a> instead, since Windows parallel builds are not reliable when using GNU make. In addition, PyMake recurses in a single process reducing the number of shell invocations, which are <a class="external" href="http://benjamin.smedbergs.us/blog/2009-04-02/pymake-25-faster-than-msys-make/" rel="external" target="_blank" title="http://benjamin.smedbergs.us/blog/2009-04-02/pymake-25-faster-than-msys-make/">particularly expensive on Windows</a>. See <a class="external" href="http://mikeconley.ca/blog/2011/11/30/build-thunderbird-faster-on-windows/" rel="external" target="_blank" title="http://mikeconley.ca/blog/2011/11/30/build-thunderbird-faster-on-windows/">Mike Conley's blog post</a> for more information.</div>
<p>On Mac OS X, and GNU/Linux to start the build, cd into the subdirectory (created automatically by the <code>hg clone</code> command), and run:</p>
<pre>make -f client.mk
</pre>
<p>Building can take a significant amount of time, depending on your system, OS and chosen build options. Linux builds on a fast box may take under 15 minutes, but Windows builds on a slow box may take several hours. <strong><a href="/en/Developer_Guide/Mozilla_build_FAQ#Making_builds_faster" rel="internal" title="https://developer.mozilla.org/en/Mozilla_Build_FAQ#Making_builds_faster">Tips for making builds faster</a></strong>.</p>
<p>Various compiled files, libraries, and the Thunderbird executable will be found in your object directory (under <code>comm-central/</code>), which is prefixed with <code>obj-</code>. The exact name depends on your system and OS. For example, a Mac user may get an object directory name of <code>obj-x86_64-apple-darwin10.7.3/</code>.</p>
<p>From the object directory, <strong>Windows</strong> users should run <code>mozilla/dist/bin/thunderbird.exe</code>, <strong>Linux</strong> users should run <code>mozilla/dist/bin/thunderbird</code>, and <strong>OS X</strong> users should run <code>dist/Daily.app/Contents/MacOS/thunderbird.</code></p>
<h4>Building Thunderbird and Lightning</h4>
<p>If you've set up you build environment as above, then all you need to do is:</p>
<pre>echo 'ac_add_options --enable-calendar' &gt;&gt; .mozconfig
</pre>
<p>in the <code>comm-central </code>directory, or just add the <code>ac_add_options --enable-calendar</code> line to your .mozconfig with your favourite editor.</p>
<p>Then just re-run the "<code>make -f client.mk</code>" command above (you can do the addition before running make for the first time)</p>
<h2>How to build again later</h2>
<p>In your <code>comm-central</code> directory, run the same command as before:</p>
<pre>python client.py checkout
</pre>
<p>Then just re-run the "<code>make -f client.mk</code>" command above. <code>make</code> will only recompile files that changed, but it's still a long haul. An <a class="internal" href="/en/Incremental_Build" title="En/Incremental Build">incremental build</a> can be faster.</p>
<h2>Problems Building?</h2>
<p>Have you:</p>
<ul> <li>Checked the <a class="external" href="http://tinderbox.mozilla.org/showbuilds.cgi?tree=ThunderbirdTrunk" title="http://tinderbox.mozilla.org/showbuilds.cgi?tree=ThunderbirdTrunk">Thunderbird tinderbox</a> for known failures at the time you pulled the code? <ul> <li>If the trunk is broken, you may wish to consider building <a href="/En/Developer_Guide/Source_Code/Getting_comm-central" title="https://developer.mozilla.org/En/Developer_Guide/Source_Code/Getting_comm-central">one of the branches</a> (to pull the source code from a branch, just replace the url to the repository in the hg clone instruction)</li> </ul> </li> <li>Have you searched the <a class="link-https" href="https://bugzilla.mozilla.org/" title="https://bugzilla.mozilla.org/">bug database</a> for issues relating to your problem (e.g. platform specific issues)?</li> <li>Try asking in <a class="external" href="http://groups.google.com/group/mozilla.dev.builds/" title="http://groups.google.com/group/mozilla.dev.builds/">mozilla.dev.builds</a> - don't forget to include details of what is in your mozconfig, and what the actual error is.</li>
</ul>
<h3>References</h3>
<ul> <li><a class="internal" href="/En/Developer_Guide/Build_Instructions" title="En/Developer Guide/Build Instructions">General Build Documentation</a></li> <li><a class="internal" href="/en/comm-central" title="en/comm-central">comm-central</a></li> <li><a href="/en/Using_the_Mozilla_symbol_server" title="en/Using the Mozilla symbol server">Using the Mozilla symbol server</a></li>
</ul>
Revert to this revision