Simple Firefox build

  • Revision slug: Simple_Firefox_build
  • Revision title: Simple Firefox build
  • Revision id: 18076
  • Created:
  • Creator: badrfoot
  • Is current revision? No
  • Comment 1 words removed

Revision Content

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

Preparing your system

Before you can build Firefox, 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 firefox
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 iceweasel

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

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. As of 06/07/11, it does not have a recipe for autoconf, but that can be obtained here. After adding that recipe, do
    sudo easy_install pip
    sudo pip install Mercurial
    sudo brew install libidl autoconf yasm

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, or Visual C++ 2010 Professional. 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.)

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 VS 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.

Building Firefox

First, if you're on Windows, you'll need to start work in a directory with no spaces in the path (e.g. don't use "Documents and Settings"). You can pick any other location, but the root of C: is handy:

cd /c

Now let's grab the latest source code from Mozilla's Mercurial code repository. This may take a while, it's a lot of code!

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

To start the build, cd into the mozilla-central subdirectory (created automatically by the previous command), and run:

make -f client.mk

This step will also take a while, depending on your system and OS. Linux builds on a fast box may take under 10 minutes, but Windows builds on a slow box may take several hours.

Various compiled files, libraries, and the Firefox executable will be found in your object directory (under mozilla-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 dist/bin/firefox.exe, Linux users should run dist/bin/firefox, and OS X users should run dist/Nightly.app/Contents/MacOS/firefox.

Configuring options

Additional configuration options are available, notably enabling debug builds and increasing build speed by using parallel compiles. These options are stored in a file named mozconfig (in the past this file was required, now default settings are used automatically). It is strongly recommended that you either use these defaults, or change as few options as your needs require.

How to update and build again

To update the code in your mozilla-central directory, run these commands:

hg pull
hg update

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.

{{ languages( { "ja": "ja/Simple_Firefox_build" } ) }}

Revision Source

<p>This page covers the basic steps needed to build a bleeding-edge, development version of Firefox. For additional, more detailed information, see the <a class="internal" href="/En/Developer_Guide/Build_Instructions" title="En/Build Documentation">build documentation</a>.</p>
<h2>Preparing your system</h2>
<p>Before you can build Firefox, 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>Linux</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 firefox
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 iceweasel</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
</pre>
<p>Problems? See <a href="/En/Developer_Guide/Build_Instructions/Linux_Prerequisites" title="https://developer.mozilla.org/En/Developer_Guide/Build_Instructions/Linux_Prerequisites">Linux build prerequisites</a>.</p>
<h3>Mac</h3>
<ul> <li>Install <a class=" link-https" href="https://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/wa/getSoftware?bundleID=20792" 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" 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">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" title="https://github.com/mxcl/homebrew">homebrew</a> is an alternative to MacPorts. As of 06/07/11, it does not have a recipe for autoconf, but that can be obtained <a class=" link-https" href="https://gist.github.com/1010716" title="https://gist.github.com/1010716">here</a>. After adding that recipe, do<br> <pre>sudo easy_install pip
sudo pip install Mercurial
sudo brew install libidl autoconf yasm</pre> </li>
</ul>
<p>Problems? See <a class="internal" href="/En/Developer_Guide/Build_Instructions/Mac_OS_X_Prerequisites" title="en/Mac_OS_X_Build_Prerequisites">Mac OS X build prerequisites</a>.</p>
<h3>Windows</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">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">.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" title="http://www.microsoft.com/downloads/details.aspx?FamilyId=F3FBB04E-92C2-4701-B4BA-92E26E408569&amp;displaylang=en">Express with SP1</a>, or Visual C++ 2010 Professional. 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" title="En/Windows SDK versions">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" 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" 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.)</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-msvcX.bat</code> (where X is 8 for VS 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" title="en/Windows_Build_Prerequisites">Windows build prerequisites</a>.</p>
<h2>Building Firefox</h2>
<p>First, if you're on Windows, you'll need to start work in a directory with no spaces in the path (e.g. don't use "Documents and Settings"). You can pick any other location, but the root of C: is handy:</p>
<pre>cd /c</pre>
<p>Now let's grab the latest source code from Mozilla's Mercurial code repository. This may take a while, it's a lot of code!</p>
<pre>hg clone http://hg.mozilla.org/mozilla-central
</pre>
<p>To start the build, cd into the <code>mozilla-central </code>subdirectory (created automatically by the previous command), and run:</p>
<pre>make -f client.mk
</pre>
<p>This step will also take a while, depending on your system and OS. Linux builds on a fast box may take under 10 minutes, but Windows builds on a slow box may take several hours.</p>
<p>Various compiled files, libraries, and the Firefox executable will be found in your object directory (under <code>mozilla-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>dist/bin/firefox.exe</code>, <strong>Linux</strong> users should run <code>dist/bin/firefox</code>, and <strong>OS X</strong> users should run <code>dist/Nightly.app/Contents/MacOS/firefox.</code></p>
<h3>Configuring options</h3>
<p>Additional <a href="/en/Configuring_Build_Options" title="en/Configuring Build Options">configuration options </a>are available, notably enabling debug builds and increasing build speed by using parallel compiles. These options are stored in a file named <code>mozconfig</code> (in the past this file was required, now default settings are used automatically). It is <strong>strongly</strong> recommended that you either use these defaults, or change as few options as your needs require.</p>
<h3>How to update and build again</h3>
<p>To update the code in your <code>mozilla-central</code> directory, run these commands:</p>
<pre>hg pull
hg update
</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>
<p>{{ languages( { "ja": "ja/Simple_Firefox_build" } ) }}</p>
Revert to this revision