Skip to content

Latest commit

 

History

History
121 lines (80 loc) · 6.38 KB

BUILDING.md

File metadata and controls

121 lines (80 loc) · 6.38 KB
Raw

Building ungoogled-chromium

Notice for master branch users: The information in this document may not apply to the latest tag version. Please consult the documentation from the tag instead.

General building requirements

The following is needed to fully use buildlib:

  • Python 3 (tested on 3.5) for running buildlib
  • The below can be provided by Google's depot_tools
    • Python 2 (tested on 2.7) for running gyp
    • Ninja for running the build command

There are additional requirements for specific platforms. See the following sections for more information.

How to build

Building is done by simply invoking build.py. It will take care of the setup and building processes.

Currently, there is no command-line-configurable build script. You must create a script or modify build.py to use buildlib.

See the following for more information.

Debian and derivatives

As of now, Debian Stretch 64-bit and Ubuntu Xenial 64-bit are tested. This may work on other Debian-based distributions and 32-bit systems

Note for Debian Jessie users: ungoogled-chromium is configured to build against the system's FFmpeg (available in Stretch and onwards); Libav (used in Jessie) will not work. However, FFmpeg is available in jessie-backports. To install it, add jessie-backports to the apt sources, and then install libavutil-dev, libavcodec-dev, and libavformat-dev from it. Note that this will replace Libav.

Run these steps on the system you want to build packages for:

# Change directory to ungoogled-chromium's root directory
dpkg-checkbuilddeps resources/debian/dpkg_dir/control # Use this to see the packages needed to build. This includes packages for "General building requirements"
./build.py

Debian packages will appear in the current working directory.

Windows

Google only supports Windows 7 x64 or newer. These instructions are tested on Windows 10 Home x64.

For maximum portability, the build configuration will generate x86 binaries.

Additional Requirements

  • Visual Studio. See Chromium's Windows Build Instructions for Google's requirements
    • Build has been tested on 2015 Community Edition Update 2 with only the following features installed:
      • Programming Languages -> Visual C++ (including all subcomponents)
      • Universal Windows App Development Tools -> Windows 10 SDK 10.0.10586
      • Windows 8.1 and Windows Phone 8.0/8.1 Tools -> Tools and Windows SDKs
  • GNU patch (to deal with patches that have fuzz). You can get the latest GNU patch from MSYS2.
    • If you don't want to use the installer, you can download and extract the following files manually from MSYS2's repository on SourceForge:
      • /usr/bin/patch.exe from patch-*-x86_64.pkg.tar.xz
      • /usr/bin/msys-2.0.dll from msys2-runtime-*-x86_64.pkg.tar.xz
      • These files are portable.
  • gperf from GNUWin32
  • bison from GNUWin32
    • Get the Binaries, Developer files, and Dependencies

Setting up the build environment

Make sure all of the following are in the PATH:

  • Python 2 as python
  • Ninja as ninja
  • GNU patch as patch
  • gperf as gperf
  • bison as bison

See build.py for more on customizing the build environment or process.

Build

# Change directory to ungoogled-chromium's root directory
path\to\python3 build.py

Mac OS

NOTE: There is no official maintainer for this platform. If there is a problem, please submit a pull request or issue

Tested on Mac OS 10.11.6

Credits to 9Morello for most of the work done on this platform.

Additional Requirements

  • Xcode 7
  • Homebrew
  • Subversion client
  • Perl (for creating a .dmg package)
  • LLVM with Clang (see next section)
  • GNU patch (see next section)

Setting up the build environment

  1. Setup Homebrew Versions if you haven't already: brew tap homebrew/versions
  2. Install GCC 4.9 via Homebrew: brew install gcc49
  3. Install GNU patch via Homebrew: brew install homebrew/dupes/gpatch
  4. Install Quilt via Homebrew: brew install quilt
  5. Try running svn info https://llvm.org/svn/llvm-project
    • If asked to verify llvm.org's certificate fingerprint, accept it permanently and run this command again
      • If still asked to accept the fingerprint, try the solutions on this page. Then try rerunning the command to verify the certificate is accepted.

See build.py for more on customizing the build environment or process.

Build

# Change directory to ungoogled-chromium's root directory
python3 build.py

Other systems, platforms, and configurations

Please read the section in the README explaning ungoogled-chromium's design first.

Consult the build instructions on the Chromium homepage for platform-specific building information.

You can use depot_tools to setup the Chromium source tree in build/sandbox if buildlib's source downloading system does not work on a platform. However, please note that this will involve executing Google binaries part of depot_tools and will run scripts that can download and run more Google binaries.

The main set of patches (in resources/common/patches) should work on most, if not all, platforms supported by desktop Chromium. Some patches are there to fix building with certain build flags, so those may not work with other platforms or configurations. However, the patches as they are should apply as long as there is a clean and unmodified source tree.

It is not recommended to run domain substitution or source cleaning, especially if your build requires additional downloads from Google.

The domain substitution list, source cleaning list, and some patches in resources/common are designed to work with the build flags defined. They may require modifications if the flags are changed.